步骤一:选择许可证类型
打开工具页面后,首先在许可证选择区域找到您项目所使用的许可证类型。工具提供了 17 种常见开源许可证供您选择。点击对应的许可证按钮,例如 MIT 或 Apache 2.0,工具会自动应用该许可证的标准配色方案和标签文字。如果您的项目使用了非标准许可证,可以选择自定义选项并手动输入许可证名称。
步骤二:选择徽章样式
在样式选择区域,从 5 种预设样式中选择您喜欢的视觉风格。Flat 样式是最通用的选择,具有圆角边框和平面设计感;Flat Square 采用直角边框,视觉上更加简洁硬朗;Plastic 样式添加了微妙的渐变效果,呈现立体质感;For the Badge 样式使用更大的字体,适合需要突出显示的场景;Social 样式则模拟社交媒体按钮的外观。
步骤三:自定义外观
在自定义选项区域,您可以进一步调整徽章的视觉细节。修改标签文字可以改变徽章右侧显示的内容,例如将 MIT License 简化为 MIT。颜色选择器允许您从预设颜色中快速选择,也可以输入自定义的 hex 颜色码。如果您希望在徽章中添加 Logo 图标,可以从 simple-icons 图标库中搜索并选择合适的图标。此外,还可以为标签背景和 Logo 分别设置独立的颜色。
步骤四:配置链接
在高级选项中,您可以为徽章添加点击跳转链接。通常建议将链接指向项目根目录下的 LICENSE 文件,例如 https://github.com/username/repo/blob/main/LICENSE。这样用户点击徽章即可查看完整的许可证文本。您也可以链接到许可证的官方说明页面,帮助用户更好地理解许可证条款。
步骤五:预览与调整
每次修改配置后,页面右侧的预览区域会实时更新徽章效果。仔细检查徽章的标签文字是否准确、颜色是否符合预期、Logo 是否正确显示。如果对当前效果不满意,可以随时返回修改任意配置项。预览支持实时缩放,您可以模拟在不同屏幕尺寸下的显示效果。
步骤六:选择导出格式
确认预览效果后,在导出区域选择适合您目标平台的代码格式。如果要将徽章添加到 GitHub README 文件中,选择 Markdown 格式;如果要嵌入 HTML 网页,选择 HTML 格式;如果只需要 shields.io 的 URL 链接,选择纯 URL 格式。每种格式旁边都提供了复制按钮,点击即可将代码复制到剪贴板。
步骤七:粘贴到项目文档
将复制的代码粘贴到您的项目文档中。对于 GitHub 项目,通常将徽章代码放在 README.md 文件的顶部区域,位于项目标题之后、正文内容之前。保存文件并推送到远程仓库后,徽章将自动显示在 GitHub 项目页面上。您可以随时返回本工具修改配置并生成新的徽章代码来更新文档。
UD5工具箱