מחולל תגים (SVG בסגנון Shields)
תצוגה מקדימה
קוד SVG
Markdown (shields.io)
Markdown (SVG באחסון עצמי)
הורידו את ה-SVG שלמעלה, בצעו לו commit למאגר שלכם (למשל בשם 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, הורדה, כתובת shields.io מקבילה ופסקאות קוד מוכנות להדבקה.
מקרי שימוש נפוצים
תגי README מסכמים סטטוס בנייה, כיסוי, גרסה, רישיון, פלטפורמות נתמכות ותמיכה כספית. השתמשו בכלי זה כשאתם רוצים תג מותאם אישית ש-shields.io לא מציע, תג שחייב לעבוד במצב לא מקוון או ברשת פרטית, או SVG סטטי שנשמר במאגר כדי שהתיעוד לא יישבר כשרשת של צד שלישי אינה זמינה. הגדרות מוכנות עבור build passing, רישיון MIT, גרסה, כיסוי ו-PRs welcome מאפשרות התחלה מהירה.
פורמטי פלט
הפלט כולל SVG גולמי, Markdown עם כתובת תמונה של shields.io, Markdown שמפנה ל-badge.svg באחסון עצמי, תג HTML מסוג img, הנחיית image של reStructuredText ומאקרו image של AsciiDoc. כתובת ה-URL הסטטית של shields.io פועלת לפי כללי ה-escaping המתועדים: מקף אחד הופך לשני מקפים, קו תחתון אחד הופך לשני קווים תחתונים ורווחים הופכים לקווים תחתונים. הכתובת נוצרת כטקסט בלבד ואינה נשלחת לעולם.
מלכודות נפוצות ומקרי קצה
צבעים שאינם שם מוכר, ערך hex או שלישיית rgb() מתעלמים מהם ונעשה שימוש בברירת המחדל, מה שמונע הזרקת markup ל-SVG. לוגואים חייבים להיות data URI של SVG או PNG בקידוד base64 והם מוטמעים כתמונות, לעולם לא כ-markup גולמי. רוחב התג הוא קירוב, ולכן גופנים חריגים מאוד או טקסט שאינו לטיני עשויים להיראות רחבים מעט מהמסגרת. GitHub מגיש קובצי SVG מהמאגר שלכם עם מדיניות תוכן מגבילה, ולכן השתמשו בכתובת ה-raw או בגרסת shields.io בעת הטמעה מחוץ למאגר.