3 种方法让你的 GitHub 个人资料 README 更精彩🔥
Github 个人资料自述文件生成器
Github 自述文件生成器
GitHub最近发布了一项功能,允许你在个人资料页面添加 README 文件。这是一个向 GitHub 社区介绍自己的好方法,可以突出你的技能和项目。在本文中,我们将探讨如何改进 README 文件!💯
Github 个人资料自述文件是什么?
自两周前发布以来,dev.to上已经有大量关于 GitHub Profile README 内容以及如何设置自己的 README 的文章。这里有一篇由Monica Powell撰写的入门文章,内容很丰富:
Caneco的这条推文概括了这一切的内容:
请注意,截至撰写本文时,此功能尚未向所有 GitHub 用户开放。
您的 README 中需要添加什么内容?
虽然有时候简洁才是王道,但我确实认为 README 能给别人(包括潜在雇主!)留下持久的第一印象。让我们来分析一下您可以添加到自己页面的一些元素。
我将使用我为 GitHub 个人资料创建的 README 作为示例。
1. 📸 添加图片和图标
将一些图像上传到您的存储库,使您的页面令人难忘。
您可以添加英雄图片,也就是页面顶部的大型横幅。这是用户访问时首先看到的内容,所以要让它更具吸引力!
您会注意到您的目光被巨大的标题图像所吸引!
想要链接到外部网站?那就添加一些图标,用于重定向到你的社交网络或项目。我使用了免费的开源RemixIcon库,只是根据配色方案调整了颜色。
需要注意的是:请确保您的图片质量上乘。我们不希望图片出现像素化。如果您使用矢量图,请使用 SVG 格式上传,而不是 JPG 或 PNG 格式。
2. 📈 包含统计数据
如果您正在使用 GitHub 进行项目开发或为开源项目做贡献,那么您可能有很多提交和拉取请求。Anurag Hazra创建了一个很棒的小工具,可以将所有这些统计数据汇总到一起!
如果您想了解更多信息,请参阅以下博客文章:
您还可以添加一个小部件来统计页面访问次数。这个由蒋文建创建的部件可以完成这项任务,而且设置起来非常简单。访客徽章的文档可在此网站找到!
3.🛠 使用 HTML
在编辑 README 时,您不仅限于使用 Markdown。GitHub的 Flavored Markdown允许使用一些 HTML 标签。
以下是您可以做的一些基本事情:
- 使用以下方式将部分居中
<center>
- 创建一个使用以下方式打开和关闭的小部件
<details>
对于高级用途,您需要阅读HTML 块部分以查看可供使用的其他标签。
希望以上内容能帮你创建自己的 README 文件!你可以在我的GitHub 个人资料中查看我的源代码。如果觉得有用,请留下⭐️!
我很想知道你的想法!请在下方添加你的 README 文件,或者在推特上@jayehernandez_。
文章来源:https://dev.to/jayehernandez/3-ways-to-spice-up-your-github-profile-readme-1276