首页首页
文章文章
标签标签
分类分类
logokzhik.cn
首页首页
文章文章
标签标签
分类分类
友情链接友情链接

如何自定义你的 Github 自述文件

2025-5-22151 0字(大约0分钟)
折腾折腾
GithubGithub
自述文件自述文件
学习笔记学习笔记

什么是Github自述文件

📖 官方文档链接 - Github文档

简单的来说就是一个普通的 Markdown文档,但它有两个特别之处:

  • 🧐 非常显眼:它会显示在你的 GitHub 主页最上方,是别人访问你主页时首先看到的内容
  • 🤓 非常简单:哪怕你不会写 Markdown,也可以在里面直接写文字,GitHub 也能帮你漂亮地展示出来

那么应该如何创建自述文件?🧐

好消息! Github官方有详细的中文操作步骤文档🎉

👉 添加个人资料自述文件 - GitHub 文档

但是其实只要一句话就能说明白:

创建一个包含README.md且与你Github用户名同名的公开仓库

其中README.md 就是 Github自述文件

如何编写自述文件?

一句话就能讲清楚:自述文件的语法就是 GitHub 风格的 Markdown,但其实它和你平常写的 Markdown 基本一样

👉 Github风格的Markdown(GFM)

👀 Github风格的Markdown(中文翻译)

我不想手动编写自述文件怎么办?

即使你一行 Markdown 都不写,也仍然可以拥有一个漂亮的 GitHub 自述文件!

最简单的办法:Fork 别人的自述文件模板,改成自己的内容。

Q&A:

  • Q:上哪找好看的自述文件?🧐
  • A: Awesome GitHub Profile READMEs 它收录了上百个风格各异的优秀 Profile 示例!
  • Q: 直接用别人的会不会有版权风险?😱
  • A:当然有⚠️ 建议查看原仓库有没有开源许可(如 MIT、Apache、BSD、GPL 等)如果有,那就放心修改吧——只要你保留原作者署名或注明参考来源就 OK!

技巧:图片 + 布局

接下来 GFM 都表示 GitHub 风格的 Markdown

GFM 是支持部分 HTML 标签的!🎉
不过需要注意:<script>、<style> 等标签是不允许使用的。
此外,虽然你不能直接在 Markdown 中写 <svg> 标签,但可以以图片形式引入 SVG 图像来实现类似效果。

利用表格实现布局

虽然 GitHub 限制了样式标签,但我们仍然可以使用 HTML 表格 <table> 标签来进行页面排版!😎 表格不仅支持多列布局,还支持合并单元格 —— 用来做横向布局非常合适。

利用图片增强视觉效果(支持 SVG/GIF)

GitHub README 完美支持外链图片,并且支持动态格式(SVG、GIF 等)。 以下是几个可以生成动态数据的开源项目:

  • 📊 GitHub Readme Stats:展示你的 GitHub 统计卡片
  • 📈 GitHub Readme Activity Graph:生成你的提交活动图表
  • 🛡️ Shields.io:生成各种徽标、标签、状态图标等

你甚至可以接入自己的 API,动态生成个性化图片,嵌入到自述文件中,打造非常炫酷的效果!

最后

你可以把 GitHub 自述文件当作一个轻量、低门槛的“个人主页”。
从 Markdown 入门,到 Fork 别人模板,再到用图片和布局丰富内容 —— 都非常适合从这里开启你的技术展示之路!👏


如何自定义你的 Github 自述文件

本博客所有文章除特别声明外,均采用CC BY-NC-SA 4.0许可协议。
转载请注明来自 www.kzhik.cn

CCBYNCSA
copyright

评论

kzhik's website


本站靠 Nodejs 和 Golang 以及我写的屎山代码居然运行了 0 天 0 时 0 分 0 秒

logo
赣ICP备2025064215号

Design & Built by kzhik

© 2025 kzhik. All rights reserved.

隐私政策友情链接RSS