跳至主要內容

使用 Shields.io 创建自定义静态徽章

诗往哥2024/12/24网站搭建徽章Shields.ioMarkdown静态网站约 778 字大约 3 分钟

前言

静态徽章(Badge)是项目 README 或文档中常见的元素,用于直观地展示状态信息,例如构建状态、代码覆盖率或版本号。Shields.io 是一个广受欢迎的免费服务,可以轻松制作这类徽章。

静态徽章示例
静态徽章示例

要创建一个基础徽章,您可以访问 Shields.io 官网,在右侧的 badgeContentpath 输入框中填入特定格式的字符串(即路径参数),例如 build-passing-brightgreen,然后点击 Execute 即可预览。最后,根据需要复制页面上提供的 URL、Markdown、HTML 等格式的代码。

相关信息

本文将深入讲解构成徽章 URL 的核心要素:路径参数查询参数

路径参数 (Path Parameters)

路径参数是构成徽章内容的基础,格式为 LABEL-MESSAGE-COLOR,三部分由英文破折号 - 分隔。

参数类型示例说明
label字符串build徽章左侧显示的文本(标签)。
message字符串passing徽章右侧显示的文本(消息)。
color字符串brightgreen右侧消息部分的背景颜色。支持多种预设颜色名和十六进制代码。

查询参数 (Query Parameters)

查询参数(也称 URL 参数)用于对徽章进行更精细的样式定制,它们以 ? 开头,并用 & 分隔。在 Shields.io 网站上,您需要展开 + Show optional parameters 来设置这些选项。

常用的查询参数如下:

查询参数类型示例说明
style字符串flat-square定义徽章的整体样式。可选值包括 flat (默认)、flat-squareplasticfor-the-badgesocial
logo字符串github在徽章左侧添加一个图标。图标名称 (slug) 来自 Simple Icons,您可以直接在该网站复制图标的 slug。
logoColor字符串white自定义 logo 图标的颜色。支持 CSS 颜色名、十六进制代码等。
labelColor字符串555自定义徽章左侧 label 部分的背景颜色。
color字符串4c1自定义徽章右侧 message 部分的背景颜色(会覆盖路径参数中的颜色设置)。
label字符串Health覆盖路径参数中设置的左侧文本。注意:空格或特殊字符需要进行 URL 编码
link字符串https://...为徽章添加点击链接。格式为 link=URL_A&link=URL_B,第一个链接应用于徽章左侧,第二个应用于右侧。

示例:一个应用了查询参数的复杂徽章

<!-- Markdown 格式 -->
![GitHub](https://img.shields.io/badge/Profile-GitHub-blue?style=for-the-badge&logo=github&logoColor=white&labelColor=101010)

效果:

GitHub
GitHub

Your primary language is en-US, do you want to switch to it?

你的首选语言是 en-US,是否切换到该语言?