如何创建 GitHub 个人资料自述文件 GitHub 个人资料自述文件生成器

2025-05-25

如何创建 GitHub 个人资料自述文件

GitHub 个人资料 README 生成器

GitHub 最近发布了一项功能,允许用户创建个人资料级别的 README 文件,并在其 GitHub 个人资料中突出显示。本文将介绍如何使用这项新功能。我还将分享一些我见过的有趣的 GitHub 个人资料。如果您能在 Twitter 上通过@waterproofheart与我分享您的 README 文件,我将不胜感激。
标题 GIF 动图展示了我撰写本文时的 README 文件。您可能注意到我最近被选为GitHub star 了

为什么要使用 README?

GitHub 个人资料级 README 功能允许比个人资料简介更多的内容,支持 markdown,这意味着您可以更直观地浏览内容(有人说 GIF 吗!?),并且 README 更加显眼,因为它位于固定存储库上方,并占用网页折叠上方尽可能多的空间。

一份完善的 README 是文档齐全的软件的核心组成部分,它通常通过与贡献者分享有用的上下文来促进协作。在我看来,个人资料级别的 README 似乎是对许多 GitHub 用户已经熟悉的惯例的一个很好的扩展。如果你想让项目级别的 README 更出色、更实用,请查看matiassingers/awesome-readme,获取资源和引人入胜的 README 示例。

如何创建个人资料自述文件?

个人资料 README 是通过创建一个与您的用户名同名的新仓库来创建的。例如,我的 GitHub 用户名是 m0nica,所以我创建了一个名为 m0nica 的新仓库。注意:在撰写本文时,为了访问个人资料 README 功能,字母大小写必须与您的 GitHub 用户名一致。

如果您已经在名为用户名/用户名的存储库中拥有一个项目,并且有兴趣设置配置文件级别的自述文件,那么我建议您根据您的特定情况重新命名该存储库或重新利用现有项目的自述文件。

  1. 创建一个与您的 GitHub 用户名同名(包括大小写)的新存储库:https://github.com/new

  2. 在新 repo 中创建一个包含内容(文本、GIF、图像、表情符号等)的 README.md 文件

  3. 提交您新奇的 README!

    • 如果您在 GitHub 的 Web 界面上,您可以选择直接提交到 repo 的主分支(即mastermain),这将使其立即显示在您的个人资料中)
  4. 将更改推送到 GitHub(如果您在本地进行了更改,即在您的计算机上而不是 github.com 上)

用于创建新存储库的 GitHub 页面的屏幕截图

有趣的 README

GitHub README 配置文件是用 Markdown 编写的,这意味着你不仅可以使用文本和链接,还可以添加 GIF 和图片。需要复习一下 Markdown 语法吗?看看这份 Markdown 速查表



如果您真的雄心勃勃,您可以使用GitHub 操作或其他自动化工具(如 bdougieYO 或 simonw)将数据动态拉入您的 README:


无服务器功能还可用于动态生成信息(例如您当前的 Spotify 活动):

我强烈主张人们应该维护一个他们完全拥有所有权的网站(即使它是一个无代码网站解决方案),但这很诱人......


到目前为止,我所看到的富有创意的 README 给了我很多启发,并期待在接下来的几个月里看到各种各样的个人资料。

文章来源:https://dev.to/m0nica/how-to-create-a-github-profile-readme-1paj
PREV
使用 Spring-Boot 进行身份验证和授权
NEXT
Angular 测试备忘单 Angular 单元测试备忘单异步行为