バッジジェネレーター(Shields スタイルの SVG)
プレビュー
SVG コード
Markdown(shields.io)
Markdown(セルフホストの SVG)
上の SVG をダウンロードしてリポジトリにコミットし(例: badge.svg)、この相対パスで参照すると、shields.io に依存せずに済みます。
HTML
reStructuredText
AsciiDoc
shields.io の静的 URL
技術的な詳細
バッジジェネレーターの仕組み
バッジジェネレーターでできること
バッジジェネレーターは、Shields スタイルのステータスバッジを単体の SVG ファイルとして作成します。ラベルとメッセージを入力し、色(brightgreen などの Shields の名前、hex、rgb 値)と 5 種類のスタイル(flat、flat-square、plastic、for-the-badge、social)から 1 つを選びます。テキスト幅は Verdana のメトリクスから近似され、バッジが内容に合わせて収まるようになっており、すべてブラウザー内で描画されます。SVG コード、ダウンロード、同等の shields.io URL、そのまま貼り付けられるスニペットが得られます。
主な利用シーン
README のバッジは、ビルドステータス、カバレッジ、バージョン、ライセンス、対応プラットフォーム、スポンサーシップをひと目で伝えます。shields.io にないカスタムバッジが欲しいとき、オフラインやプライベートネットワークでも動作させたいとき、サードパーティのサービスが停止してもドキュメントが壊れないよう静的な SVG をリポジトリにコミットしたいときに便利です。build passing、MIT license、version、coverage、PRs welcome のプリセットですぐに始められます。
出力形式
出力には、生の SVG、shields.io の画像 URL を使った Markdown、セルフホストの badge.svg を指す Markdown、HTML の img タグ、reStructuredText の image ディレクティブ、AsciiDoc の image マクロが含まれます。shields.io の静的 URL は文書化されたエスケープ規則に従います。ダッシュは 2 つのダッシュに、アンダースコアは 2 つのアンダースコアに、スペースはアンダースコアになります。URL はテキストとして生成されるだけで、リクエストされることはありません。
よくある落とし穴とエッジケース
認識できる名前、hex 値、rgb() の 3 つ組のいずれでもない色は無視されて既定の色が使われるため、SVG へのマークアップの混入を防げます。ロゴは base64 の SVG または PNG の data URI である必要があり、画像として埋め込まれ、生のマークアップとして扱われることはありません。バッジの幅は近似値のため、非常に珍しいフォントや非ラテン文字では枠より少し広く表示されることがあります。GitHub はリポジトリの SVG を厳しいコンテンツポリシーで配信するため、リポジトリ外に埋め込む場合は raw URL または shields.io のバリアントを使用してください。