Home
avatar

UF4

关于网页中页脚徽章的制作(一)

动态 XML 徽章(Shields.io)使用指南

目录

动态 XML 徽章(Shields.io)使用指南

官网

一、什么是动态 XML 徽章?

动态 XML 徽章(Dynamic XML Badge)是 shields.io 提供的可自定义的徽章生成服务,用于在 GitHub、文档或网页中显示动态信息(如版本号、构建状态、下载量等)。通过 URL 参数可灵活配置徽章样式和内容,支持多种主题和颜色。

二、快速入门:生成徽章

1. 基础语法

动态 XML 徽章的 URL 格式为:

https://shields.io/badge/<label>-<message>-<color>
  • 参数说明:
    • <label>:徽章左侧的标签(如 VersionBuild)。
    • <message>:徽章右侧的动态信息(如 v1.0.0Passing)。
    • <color>:徽章背景颜色(支持名称或十六进制代码,如 green#4C9)。

2. 示例

生成一个绿色的“版本 v2.1.3”徽章:

![Version](https://shields.io/badge/Version-v2.1.3-green)

渲染结果:
Version

三、高级用法与参数配置

1. 自定义颜色

支持以下颜色格式:

  • 预设颜色名称:brightgreenorangeredblue 等。
  • 十六进制颜色代码:如 #4C1(亮绿色)、#e05d44(橙色)。

示例:使用十六进制颜色

![Downloads](https://shields.io/badge/Downloads-10k-#4C1)

渲染结果:
Downloads

2. 动态数据源

若需从外部 API 获取动态数据(如 GitHub 仓库的星级或下载量),可使用 Shields.io 的动态徽章 功能。
格式:

https://shields.io/badge/<label>-<API_endpoint>-<color>

例如,获取 GitHub 仓库的星级:

![GitHub Stars](https://shields.io/badge/GitHub_Stars-https://api.example.com/stars-Blue)

3. 多语言与编码

  • 特殊字符:需对空格等字符进行 URL 编码(如空格替换为 %20)。
  • 中文支持:直接使用中文参数,但需确保 URL 编码正确。
![中文徽章](https://shields.io/badge/状态-成功-绿色)

渲染结果:
中文徽章

常见应用场景

1. GitHub 仓库 README

在 README.md 中添加构建状态徽章:

![Build Status](https://shields.io/badge/Build-Passing-brightgreen)

渲染结果:
Build Status

2. 文档版本说明

展示文档版本:

![Document Version](https://shields.io/badge/Document_Version-v1.0-blue)

渲染结果:
Document Version

3. 网站底部版权信息

在网站底部添加版权信息:

![Copyright](https://shields.io/badge/Copyright-2023-blue)

渲染结果:
Copyright

4.依赖管理

在依赖管理页面添加依赖徽章:

![Python Version](https://shields.io/badge/Python-3.8+-yellow)

渲染结果:
Python Version

更多示例

# My Project
![Version](https://shields.io/badge/Version-v1.0.0-green) 
![License](https://shields.io/badge/License-MIT-blue) 
![Build](https://shields.io/badge/Build-Passing-brightgreen)

渲染结果:
Version
License
Build
更多示例,请访问 Shields.io 网站。