GitHub Readme Stats

GitHub Readme Stats#

本文档介绍在 Sphinx 文档中使用 GitHub Readme Stats 的指令（模块：github_readme_stats），通过三条指令嵌入 GitHub Readme Stats 卡片：用户统计、常用语言、置顶仓库。

快速开始#

在你的扩展入口或 conf.py 中注册指令：

extension = ["mystx.ext.github_readme_stats"]

用法示例#

GitHub StatsTop LanguagesPinned Repo

用法示例（reStructuredText）#

.. github-stats::
   :username: octocat
   :theme: dark
   :show_icons:
   :hide: issues,contribs

.. github-top-langs::
   :username: octocat
   :layout: compact
   :theme: dark
   :langs_count: 8

.. github-pinned-repo::
   :username: octocat
   :repo: hello-world
   :theme: dark

指令与选项说明#

github-stats（用户统计卡片）#

  • username（必填）：GitHub 用户名。

  • theme（可选）：主题名称，默认 default。

  • show_icons（可选 flag）：出现该选项即显示图标。

  • hide（可选）：以逗号分隔的统计项列表，例如 issues,contribs。

github-top-langs（常用语言卡片）#

  • username（必填）：GitHub 用户名。

  • layout（可选）：布局样式，默认 compact。

  • theme（可选）：主题名称，默认 default。

  • langs_count（可选）：展示语言数量，默认 6。

github-pinned-repo（置顶仓库卡片）#

  • username（必填）：GitHub 用户名。

  • repo（必填）：仓库名。

  • theme（可选）：主题名称，默认 default。

注意事项#

  • 这些指令依赖外部服务 https://github-readme-stats.vercel.app/，渲染结果与可选参数由该服务决定。

  • 仅支持上述列出的选项；若需更多定制（如 commits_year、show 等），请参考上游项目并扩展指令的 option_spec。

  • 主题示例（由上游项目内置）：dark、radical、merko、gruvbox、tokyonight、onedark、cobalt、synthwave、highcontrast、dracula 等。

  • 如需显示私有统计或提升速率限制，请考虑按照上游说明在自己的平台部署该服务并配置令牌。

相关链接#

  • 参考项目主页：GitHub Readme Stats

  • Stats 卡片文档：详见项目页面的 “GitHub Stats Card” 章节

  • Top Languages 卡片文档：详见项目页面的 “Top Languages Card” 章节

  • Extra Pins（置顶仓库）文档：详见项目页面的 “GitHub Extra Pins” 章节

目录