How To Create A GitHub Profile R

原文地址：How To Create A GitHub Profile README
翻译博客：博客园地址

README

GitHub最近更新了一项新功能，它可以让用户创建一个可配置的README来在他们的Githb个人主页中突出展示。本文来探索一下怎样使用这项新特性。我也会分享我看到过的的一些有趣的Github个人主页。如果你在Twitter @waterproofheart上与我分享自己的作品，我会很喜欢。
头部的gif展示的就是我在写这篇文章时的README的样子。你可能注意到了我最近有收到Github star!

为什么是READMEs

Github的可配置个人主页的READEME这个特性和一般的个人主页相比可以容纳更多的内容，支持markdown意味着你可以做出更多直观富有表现力的内容（有人说GIF!?），README放置在固定仓库的上方，并且可以根据需要占据尽可能多的空间，因此它的曝光率明显更高。

一个可靠的README文件是文档完善软件的核心部件，通常通过与贡献者共享有用的上下文信息来鼓励协作。我认为可配置级别的README似乎是一个重大的许多GitHub用户已经熟悉的扩展。如果你希望让你的项目级的README更出色，更有用，请查看matiassingers/awesome-readme，以获取资源和查看引人注目的REDMEME示例。

如何创建一个个人信息的README

个人信息的README是通过新建一个新的和自己用户名一样名字的新仓库来创建的。例如，我的GitHub用户名是m0nica，因此我新建一个名字叫做m0nica的仓库。注意：在写作本文时，为了能使用个人主页的README的特性，字母大小写必须和你的GitHub用户名的大小写相对应。

如果你已经有一个以你的用户名/你的用户名命名的项目并且对设置个人主页的README感兴趣，然后我建议根据你特定情况来选择最有意义的方式重命名这个仓库或者重新利用已经存在项目的README。

1. 新建一个同GitHub用户名同名（包括大小写）的仓库：https://github.com/new

2. 在新仓库中新建一个包含一些内容（文本，动图，图片，表情符号等等）的README.md文件

3. 提交你喜欢的README

• 如果你在Github的web界面上直接选择提交到仓库主分支（即master或者main），这将使其立即在你的个人主页上生效。

4. 提交修改到Github（即如果你在本地修改了而不是在github.com上）

image

有趣的README

GitHub README是用Markdown编写的，这意味着不局限于文本和链接，你可以包含GIF和图片。你需要重新学习Markdown语法吗? 点击这里查看Markdown备忘手册

1

<video src='https://video.twimg.com/tweet_video/EcfZLYLWAAAOGrw.mp4' controls="controls" style='width:400px'></video>

<video src='https://video.twimg.com/tweet_video/EcdsD40WsAMIAyN.mp4' controls style='width:400px'></video>

如果你不满足于此，你可以利用GitHub的动作或者其他自动化的工具像bdougieY0 或 simonw 来将数据动态提取到你的README中：

<video src='https://video.twimg.com/tweet_video/EcmC4YJU0AASMxq.mp4' controls style='width:400px'></video>

2

Serverless functions也可用于动态生成信息（例如当前的Spotify活动）：

<video src='https://video.twimg.com/ext_tw_video/1282324807053455360/pu/vid/488x270/yv-WDfwn6LMPdfkR.mp4?tag=10' controls style='width:400px'></video>

我强烈建议人们维护一个他们拥有所有权的网站（尽管这是一个无代码的网站解决方案）但这很诱人。。。

image image

目前位置，我已经看到了富有创意的README，这使我深受启发。并期望在接下来几个月鞥看到各种各样的个人主页。