GitHub 个人资料 README 生成器

结果

创建一个名称与你的 GitHub 用户名相同的仓库,即可获得一个显示在个人资料页顶部的 README。该生成器会为该仓库生成一份整洁的 Markdown 文件:标题、简短介绍、技术栈,以及由 github-readme-stats 实时驱动的可选统计卡片。

如何创建个人资料 README

  1. 1

    填写你的信息

    显示名称、标语、所在地,以及你正在做的事和正在学习的内容。

  2. 2

    添加你的技术栈

    以逗号分隔的列表;每一项都会渲染为一个加粗的标签。

  3. 3

    启用统计卡片

    GitHub Stats 和 Top Languages 卡片会从 github-readme-stats 实时渲染;活动选项会添加一个指向你贡献图的链接。

  4. 4

    复制 Markdown

    创建一个以你的用户名命名的仓库,并将 README.md 推送到根目录。

“特殊仓库”的原理

如果你的用户名是 alex,并创建了一个名为 alex 的公开仓库,GitHub 就会将该仓库的 README.md 渲染在你的个人资料页上(位于“热门仓库”上方)。这是官方文档记载的功能,而非取巧的做法。

生成器可嵌入的卡片

卡片 来源 URL 备注
GitHub 统计 github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true 提交、PR、issue
主要语言 github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... 按仓库大小划分的语言分布
贡献活动 github.com/{username}?tab=overview 开启“Streak”时显示的链接

这两张统计卡片都是 PNG 端点,可在任何 Markdown 阅读器中渲染,包括别人未登录直接打开你的个人资料时;活动链接会在 GitHub 上打开你的贡献图。

读起来舒服的内容

  • 一行标语:角色 + 方向(“Rust 基础设施工程师,关注链路追踪”)。
  • 技术栈上方最多 3~5 个要点;再多就像在堆砌简历了。
  • 以标签形式呈现技能,而不是一整段文字。读者是在快速扫读技术。
  • 指向你真正在维护的项目的链接。把废弃的仓库固定在个人资料上,比什么都不放更糟。
  • 一行联系方式:邮箱或一个社交账号;不要罗列六个社交网络。

不要放在这里的内容

  • 私人地址或电话号码。
  • 招聘话术(“Open to work”应放在 LinkedIn 或 GitHub 的横幅选项里)。
  • 每一行都堆表情符号,一两个没问题,一大片就成了噪声。

常见问题

github-readme-stats 托管在 Vercel 上,偶尔会触发速率限制或缓存过时数据。如果某张卡片失效,请等几分钟,或自行托管该项目,仓库里提供了一键部署到 Vercel 的按钮。

只有当你用具备 repo 权限范围的令牌对该服务进行授权时才会包含。默认情况下,统计只计入公开提交,这在公开个人资料上通常是正确的选择。

可以。GitHub 允许在 Markdown 中使用一部分 HTML,<img><details><sub><sup> 以及简单的内联样式。出于安全考虑,脚本和表单会被移除。

不会。你输入的值会发送到我们的服务器以生成预览,在分步视图中它们会随页面链接在步骤之间传递。数据库不会保存任何内容,关闭标签页时所有数据都会被丢弃。

相关工具

此工具还提供其他语言版本