最简单的方式自定义github主页 readme文件

最简单的方式自定义github主页

写在前面

今天无意间发现别人的github主页怎么都这么beautiful啊,就像这自己也搞一个。方式有很多,翻了一下github的文档,发现了一种最简单的方式 – 在主页展示一个readme文件。以下内容翻译并节选自文档https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme

要求

如果满足以下要求,Github将会在你的主页上展示的个人资料的README文件。

  1. 已经创建了一个名称与Github用户名相同库。
  2. 这个库是public的。
  3. 这个库的根目录下包含一个名为README.md文件。
  4. README.md文件中有内容。

步骤

创建库,New Repository。

将Repository name设置为与用户名相同。
在这里插入图片描述
当我们把库名字和用户名相同时,会激活一个小彩蛋。提示我们,发现了一个秘密。
在这里插入图片描述
在这里插入图片描述

修改README.md文件

创建完库后,预生成的README文件中预先填充了一个模板。
在这里插入图片描述
在这个README中不仅仅可以只写文字,也可以加一些图片,表情或者GIF动图。可用的表情符号,可以参阅“ Changing a repository’s visibility.

我们再打开我们的主页时,会把我们README的内容展示出来,算是一点点装饰。

GitHubREADME文件通常是存储在项目的根目录下,用于向访问该项目的人提供关于项目的简介、安装方法、使用方法、贡献指南、许可证信息等重要信息。在一些项目中,README文件的结构可能包含一个分支结构的说明,这通常用于指导用户如何选择或切换到不同的代码分支以满足不同的需求或测试不同的版本。 一个包含分支结构的README文件可能会按照如下格式来描述分支信息: ``` # 项目名称 ## 分支结构 - `master` 或 `main`:这是项目的稳定分支,所有的正式发布都应该是从这个分支发布的。 - `dev` 或 `development`:这是开发的主要分支,包含正在进行的开发工作。除非特定功能即将完成并准备好发布,否则通常不建议直接在这个分支上进行开发。 - `feature/*`:以 `feature/` 开头的分支用于新功能的开发。每个新功能应该在自己的分支中开发,完成后可以合并到 `dev` 分支。 - `hotfix/*`:以 `hotfix/` 开头的分支用于紧急修复。这些分支通常基于 `master` 分支,修复完成并合并后,相关的更改也应该被提交到 `dev` 分支和 `master` 分支。 - `release/*`:以 `release/` 开头的分支用于准备发布的版本。当一个版本准备发布时,会从 `dev` 分支创建一个发布分支,在该分支上完成最终的测试和准备工作,然后合并到 `master` 分支并发布。 ## 如何切换分支 要切换到特定的分支,请按照以下步骤操作: 1. 确保您处于项目的根目录下。 2. 使用以下命令来切换到目标分支(以 `dev` 分支为例): ```bash git checkout dev ``` 3. 如果您想创建并切换到一个新的功能分支,可以使用: ```bash git checkout -b feature/new-feature-name ``` 请注意,实际项目中的分支结构可能会有所不同,具体要根据项目的实际情况和团队的工作流程来确定。 ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值