github中readme的一些用法

  1. 标题。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。

#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题

注意井号#和标题名称要并排写作一行,显示效果如图:
在这里插入图片描述

  1. 斜体:可以使用* 或 _ 包围文字,例如Hello World

  2. 加粗:用两个 * 或 _ 包起来的话,达到加粗字体的左右,例如Hello Markdown。如果你的 * 和 _ 两边都有空白的话,它们就只会被当成普通的符号。

  3. 单行文本框:只要两个Tab再输入文字即可。

  4. 多行文本框:你可以写入代码等,每行文字只要输入两个Tab再输入文字即可。

  5. 引用:引用是使用类似 email 中用 > 的引用方式,例如:> 文字被些字符包围开始,可以在每行上加上“<”,也可以只在首行加上“<”能够达到一样的效果。区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 > :
    在这里插入图片描述

  6. 列表
    无序列表使用星号、加号或是减号作为列表标记,例如:*Red、+Green、-Blue
    有序列表则使用数字接着一个英文句点,例如:1.hello;注意,你在列表标记上使用的数字并不会影响输出的 HTML 结果,你可以使用1. Bird 1. McHale 1. Parish甚至6.ADC 3.EFG 9.XYZ 都可以实现正确的有序列表显示。

  7. 超链接
    Markdown 支持两种形式的链接语法: 行内式和参考式两种形式。

不管是哪一种,链接文字都是用 [方括号] 来标记;要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:This link has no title attribute

如果你是要链接到同样主机的资源,你可以使用相对路径:See my About page for details

参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:This is [an example][id] reference-style link

接着,在文件的任意处,你可以把这个标记的链接内容定义出来:[id]: http://example.com/ “Optional Title Here”

  1. 图片
    图片的语法和超链接非常相似。只显示图片:![github](http://example.com/unicorn.png “github”);
    点击图片进入另一个网页:![image] [image]: http://example.com/example.png “example“

  2. 缩进:缩进的含义是很容易理解的。
    在这里插入图片描述

  3. 换行: 如果你确实想要依赖 Markdown 来插入
    标签的话,在插入处先按入两个以上的空格然后回车。

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、付费专栏及课程。

余额充值