سازنده نشان (SVG به سبک Shields)
پیشنمایش
کد SVG
Markdown (shields.io)
Markdown (SVG میزبانیشده توسط خودتان)
SVG بالا را دانلود کنید، آن را در مخزن خود کامیت کنید (مثلاً با نام badge.svg) و با این مسیر نسبی به آن ارجاع دهید تا به shields.io وابسته نباشید.
HTML
reStructuredText
AsciiDoc
URL ایستای shields.io
جزئیات فنی
سازنده نشان چگونه کار میکند
سازنده نشان چه کاری انجام میدهد
سازنده نشان، نشانهای وضعیت به سبک shields را بهصورت فایلهای SVG مستقل میسازد. یک برچسب و یک پیام وارد کنید، رنگها را انتخاب کنید (نامهای shields مانند brightgreen، مقادیر hex یا rgb) و یکی از پنج سبک را برگزینید: flat، flat-square، plastic، for-the-badge یا social. عرض متن بر اساس معیارهای فونت Verdana تقریب زده میشود تا نشان با محتوایش جور شود و همه چیز در مرورگر شما رندر میشود. کد SVG، دانلود، URL معادل shields.io و قطعهکدهای آماده برای چسباندن دریافت میکنید.
موارد استفاده رایج
نشانهای README وضعیت بیلد، پوشش آزمون، نسخه، مجوز، پلتفرمهای پشتیبانیشده و حمایت مالی را خلاصه میکنند. وقتی نشان سفارشیای میخواهید که shields.io ارائه نمیدهد، نشانی که باید آفلاین یا در شبکه خصوصی کار کند، یا SVG ایستایی که در مخزن کامیت میشود تا با از کار افتادن سرویس شخص ثالث مستندات خراب نشود، از این ابزار استفاده کنید. پیشتنظیمهای build passing، مجوز MIT، نسخه، coverage و PRs welcome شروعی سریع به شما میدهند.
فرمتهای خروجی
خروجی شامل SVG خام، Markdown با URL تصویر shields.io، Markdown که به badge.svg میزبانیشده توسط خودتان اشاره میکند، تگ img در HTML، دستور image در reStructuredText و ماکروی image در AsciiDoc است. URL ایستای shields.io از قوانین escape مستند پیروی میکند: یک خط تیره به دو خط تیره، یک زیرخط به دو زیرخط و فاصلهها به زیرخط تبدیل میشوند. URL فقط بهصورت متن تولید میشود و هرگز درخواست نمیشود.
نکات احتیاطی و حالتهای مرزی
رنگهایی که نام شناختهشده، مقدار hex یا سهتایی rgb() نباشند نادیده گرفته میشوند و رنگ پیشفرض به کار میرود، که از تزریق نشانهگذاری به SVG جلوگیری میکند. لوگوها باید data URI با کدگذاری base64 از نوع SVG یا PNG باشند و بهصورت تصویر جاسازی میشوند، نه هرگز بهصورت نشانهگذاری خام. عرض نشان تقریبی است، بنابراین فونتهای بسیار غیرمعمول یا متن غیرلاتین ممکن است کمی پهنتر از کادر رندر شوند. GitHub فایلهای SVG را از مخزن شما با سیاست محتوایی سختگیرانه ارائه میدهد، پس هنگام جاسازی بیرون از مخزن از URL خام یا نسخه shields.io استفاده کنید.