用美观、可配置的徽章与状态卡片，让你的 README 更专业、更高效！

在线文档 · English

Tip

Badge（徽章）是嵌入在项目 README 文件中的 SVG 矢量图标，用于直观展示项目状态、版本、测试覆盖率等关键信息‌。

📑 小部件目录

• Shields.io
• Badgen
• GitHub Readme Stats
• Custom Icon Badges
• FOR THE BADGE
• Readme Typing SVG
• Discord
  • Discord Markdown Badge
  • Discord Cards
  • Discord Guild Widget
  • Discord README Badge
  • Lanyard Profile Readme
• 娱乐
  • Genshin Card
  • Git Animals
  • Github Readme Steam Card
  • Steam Stats
• Github
  • Contributors Img
  • GitHub Gists Readme
  • GitHub Achievements
  • Github Contribution Stats
  • Github Immortality
  • GitHub Profile Summary Cards
  • GitHub Profile Trophy
  • Github Readme Activity Graph
  • Github Readme Streak Stats
  • Github Stats Card
  • Github Stats
  • GitHub Widgetbox
  • GitHub Workflows Badge
  • Github Chart API
  • Open Source Software Insight
  • Pac-Man Contribution Graph Game
  • Repobeats
  • snk
  • Socialify
  • Spark
  • GitHub Starlines
  • AWESOME Github Stats
• 音乐
  • Last.fm Recently Played README
  • Data Card for Spotify
  • Spotify Recently Played README
• 其他平台
  • GitHub Readme YouTube Cards
  • GitHub Twitter Card Embed
  • Stackoverflow Readme Profile
  • Stats Cards
• 名言引用
  • Github Readme Quotes (PiyushSuthar)
  • Github Readme Quotes (shravan20)
• 学习
  • Duolingo Stats Card
  • GeeksForGeeks Stats Card
  • LeetCode Badge Showcase
  • LeetCode Stats Card
• 访客统计
  • GitHub Profile Views Counter
  • Profile views counter
  • HITS
  • Moe Counter
  • Profile Counter
  • Visitor Badge
• Badge Poser
• Capsule Render
• Deploy Badge
• Gradgen
• Iconify
• m3 Markdown Badges
• NodeICO
• Open Collective
• OpenSSF Best Practices Badge
• PlayBadges
• README Jokes
• Sloc Cloc and Code
• Skill Icons
• Star History
• Version Badge
• WakaTime
• Widget Bite

🏃 如何使用

# 安装依赖
pnpm install
# 运行项目
pnpm dev
# 构建项目
pnpm build

✍ 添加小部件

• Fork 项目
• 参考模板文件 template.json 或 template.yaml，在 widgets 目录下新建一个 JSON 或 YAML 文件，并按照模板格式填写小部件信息内容。
• pnpm dev 或者 pnpm dev:docs 启动项目, 查看小部件效果。
• 使用 pnpm commit 命令并选择 docs 提交 PR, 等待合并。

🌏 添加语言

• Fork 项目
• 在 meta.json 配置文件的 locales 字段中添加新的语言配置。
• 为 widgets 目录下小部件信息文件添加对应的语言版本。
• 使用 pnpm commit 命令并选择 docs 提交 PR, 等待合并。

💖 感谢

最后，如果能够帮助到你，还请多多 Star 项目，感谢你的关注。