徽章產生器(Shields 風格 SVG)
預覽
SVG 程式碼
Markdown (shields.io)
Markdown(自行代管的 SVG)
請下載上方的 SVG,將其提交到你的儲存庫(例如命名為 badge.svg),並使用此相對路徑引用,以避免依賴 shields.io。
HTML
reStructuredText
AsciiDoc
shields.io 靜態 URL
技術細節
徽章產生器的運作方式
徽章產生器的功能
徽章產生器可將 shields 風格的狀態徽章產生為獨立的 SVG 檔案。輸入標籤和訊息,選擇顏色(shields 顏色名稱如 brightgreen、十六進位或 rgb 值)以及五種樣式之一:flat、flat-square、plastic、for-the-badge 或 social。文字寬度根據 Verdana 字型度量估算,使徽章貼合內容,所有轉譯都在瀏覽器中完成。你可以取得 SVG 程式碼、下載檔案、等效的 shields.io URL 以及可直接貼上的程式碼片段。
常見使用情境
README 徽章用於概括建置狀態、涵蓋率、版本、授權、支援的平台和贊助資訊。當你需要 shields.io 未提供的自訂徽章、需要在離線或內部網路環境中使用的徽章,或希望把靜態 SVG 提交到儲存庫,避免第三方服務停擺時文件失效,就可以使用此工具。內建的建置通過、MIT 授權、版本、涵蓋率和 PRs welcome 預設組合可協助你快速上手。
輸出格式
輸出包括原始 SVG、帶 shields.io 圖片 URL 的 Markdown、指向自行代管 badge.svg 的 Markdown、HTML img 標籤、reStructuredText image 指令和 AsciiDoc image 巨集。shields.io 靜態 URL 遵循文件規定的跳脫規則:一個連字號變為兩個連字號,一個底線變為兩個底線,空格變為底線。該 URL 僅作為文字產生,不會被請求。
常見陷阱與邊界情況
不是可辨識名稱、十六進位值或 rgb() 三元組的顏色會被忽略並使用預設值,藉此防止向 SVG 注入標記。標誌必須是 base64 的 SVG 或 PNG data URI,並作為影像嵌入,絕不會作為原始標記嵌入。徽章寬度是近似值,因此非常特殊的字型或非拉丁文字的顯示寬度可能略大於徽章框。GitHub 對儲存庫中的 SVG 採用嚴格的內容政策,因此在儲存庫之外嵌入時,請使用 raw URL 或 shields.io 版本。