两个月前,GitHub 悄悄上线了一个全新的个人页功能,显示一个自定义的 README.MD 在个人首页。要激活此功能,需要新建一个与自己 ID 同名的 Repository,新 Repo 里的 README.MD 将出现在你的首页。

hayschan/hayschan is a special repository. Its README.md will appear on your public profile!

hayschan/hayschan 是一个特殊的库。 它的 README.md 将出现在您的公开资料中!

目前大部分人将此用作个人介绍:

Spencer Woo 的 GitHub 主页

这个功能非常适合以简短的句子介绍自己,并且加上一些社交媒体的链接。截图里使用了 Substats 来构建社交媒体的小徽章。详情请参考 Spencer 大佬的 这篇文章

过往,Github 已经有 profile 的功能,也就是左方小小的一句介绍、邮箱、网站。新的 README.MD 所处的位置和面积更显眼,承载的信息量提高,而且还支持 markdown,意味着超强的定制化,有不少大佬已经玩出了新花样。

新花样

有人使用 GitHub Actions 折腾出自动更新个人 README.MD,把动态的 Releases 和博客文章加到其中:

汇聚 Releases、最新的博客文章

有人则建造了显示播放中的 Spotify 音乐的功能:natemoo-re

GitHub Readme Stats

我们都想把自己光辉的一面展现出来,在 GitHub 上,光辉指 Stars、Commits。

GitHub Readme Stats 动态地把 GitHub 数据展现在个人 README.MD 中,满足大家展现 装X 人性美的欲望。制作非常简单,一句:

[![我的 GitHub 数据](https://github-readme-stats.vercel.app/api?username=GitHub用户名)]()

就能制作出花里花俏的 GitHub 数据卡片:

各种风格的卡片(几乎每一个细节都能自定义)

在链接里加入各种参数,更能定制字体、背景、主题、边框——功能强大。至少要个二十来分钟才能把文档页的可定制项看完。实际效果如下:

Alt Text
GitHub 卡片作者的 README

好事者更评出最佳的个人主页,汇聚成表:

如何创造自己的 README.MD

第一步:创建新的 Repository,仓库名为自己的用户名,形如 仓库名/用户名 -> hayschan/hayschan

第二步:修改你的 README.md,可以简简单单介绍下自己,或者加上前文提到的花里花俏(这步使用 markdown 语言)

例子

这里以我的 README 当例子(参考了 Spencer Woo):

### Yoo, I'm Hays Chan 👋

[![GitHub](https://img.shields.io/badge/dynamic/json?logo=github&label=GitHub&labelColor=495867&color=495867&query=%24.data.totalSubs&url=https%3A%2F%2Fapi.spencerwoo.com%2Fsubstats%2F%3Fsource%3Dgithub%26queryKey%3Dhayschan&style=flat-square)](https://github.com/hayschan)
[![RSS](https://img.shields.io/badge/dynamic/json?logo=rss&logoColor=white&label=RSS&labelColor=95B8D1&color=95B8D1&query=%24.data.totalSubs&url=https%3A%2F%2Fapi.spencerwoo.com%2Fsubstats%2F%3Fsource%3Dfeedly%257Cinoreader%257CfeedsPub%26queryKey%3Dhttps://haysc.tech/feed.xml&style=flat-square)](https://haysc.tech/)

- 🍻 Junior at 🇨🇳 [PKU](https://www.pku.edu.cn), _BSc in Computer Science_
- ⚡ C++ / Python.
- 🖋 Writer at [sspai](https://sspai.com/u/aw0luepf/posts)
- ✍️ [Blogger](https://haysc.tech)
- 🏃 Sailing / Kayak / Scuba Diving / Windsurfing / Table Tennis / Cycling
- 🥋 Boxing / Tai Chi
- ♟ Chinese Chess / Chess 

<h6>* These nice badges are generated by <a href="https://shields.io/">Shields.io</a> and <a href="https://github.com/spencerwooo/Substats">Substats</a>.</h6>

放在 GitHub 的效果如图:

小结

以上就是 GitHub 个人页 README 的简单介绍,支持 markdown,有很多自定义的选项。利用网上其他人做的功能,例如徽章、卡片,相信每个人都能做出带个人风格的主页。

最后,欢迎 Follow 我:GitHub博客

参考

How to Create a Github Profile README Using Markdown

How To Create A GitHub Profile README

题图来自 Unsplash