Github中Readme的编写基本规范

README-Learning

README是github上用来给读者快速理解作者本意的序言，个人理解感觉类似于“说明书”一样。它的排版非常简单，与CSDN中的编辑文本类似，可以直接在<>Edit file里面编写就行，然后Preview changes可以预览效果。下面是我个人整理的README语法学习记录，希望持续更新中！

1. 文本换行

1.1 说明：

换行是我们写README第一个要使用的语法，不像word中直接按enter键就可以实现换行。在README中需要在某句话的末尾加上[空格][空格][Enter]或者< br >(注意这里没有空格)实现换行。

1.2 效果：

换行前：大家好，我叫Alice，来自BUAA，我很高兴认识你们！
换行后：大家好，我叫Alice，来自
BUAA，我很高兴认识你们！

2. 文本高亮

2.1 说明：

若想在一段话中高亮显示，只需要在高亮的文本的前后加上``(反引号)就可以实现。这个是在半角输入法下，Tab键的上面。

2.2 效果：

大家好，我叫Alice，来自BUAA，我很高兴认识你们！

3. 文本强调

3.1 说明：

• 对于加粗可以在本文前后加上**或__就可以实现加粗。效果：加粗;
• 对于斜体可以在文本前后加上*或_就可以实现斜体。效果：斜体;
• 对于删除线可以在文本前后加上~~就可以实现删除线。效果：删除线;
• 对于斜粗体线可以在文本前后加上***或___就可以实现斜粗体。效果：斜粗体;

3.2 效果：

大家好，我叫Alice，来自BUAA，我很高兴认识你们！

4. 文本居中

4.1 说明：

有时候我们需要对一些文本或者图片居中对齐，则需要使用<p[空格]align="center">内容</p>来使得文本居中。

<p align="center">  
大家好，我叫Alice，来自BUAA，我很高兴认识你们！  
</p>   

特别注意：最好在输入完成后空一行，不然后面所有的文本都会居中。

4.2 效果：

大家好，我叫Alice，来自BUAA，我很高兴认识你们！

5. 标题分级

5.1 说明：

一般使用井号键#和标题名写作一行来实现不同级别标题，不同数量的井号对应不同级别的标题

• 使用#[空格]实现一级标题；
• 使用##[空格]实现二级标题；
• 使用###[空格]实现三级标题；
• 使用####[空格]实现四级标题；
• 使用#####[空格]实现五级标题；
• 使用######[空格]实现六级标题；

5.2 效果：

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

6. 横线效果

6.1 说明：

往往我们需要使用横线来为每个小节区分，分别可以用另起一行输入***或---或___来区分，特别注意前面都是至少需要三个及以上符号。

6.2 效果：

---

---

---

7. 多行文本

7.1 说明：

对于连续的几行文本可以使用1个Tab或者4个空格来实现（若不行，可以试着前面空一行）

7.2 效果：

大家好，我叫Alice
来自BUAA
我很高兴认识你们！

8. 显示图片

8.1 说明：

若想插入图片，可使用![alt](URL "title")来实现，注意都是英文输入法，其中

• alt表示图片加载失败时显示的文本
• URL表示该图片的位置
• titile是鼠标悬停在图片时显示的文本
  或者用.<img src="URL" width="300" height="450" />来显示固定大小图片，另外用.<div align=center><img src="URL" width="300" height="450" /></div>实现固定大小图片的居中显示。(注：在Edit模式下，居中效果不会显示，需要commit后才能看到）

8.2 效果：

（无，需要填写您Github中图片的地址或者是网站地址。）

9. 插入表格

9.1 说明：

若想插入表格，是比较麻烦的，不能实现直接的插入表格，而是需要按照格式输入进去。特别注意，插入表格前需要空一行，不然不能正确输出。且符号|和-两侧至少需要一个空格。基本格式为

| 表头1 | 表头2 | 表头3 |  
| --- | --- | --- |  
| 内容 | 内容 | 内容 |  
| 内容 | 内容 | 内容 |  

在表头下方的分割线标记中加入:，可以实现对齐方式：

| left | center | right |  
| :--- | :---: | ---: |  
| aaaaa | bbbbb | ccccc |  
| aa | bb | cc |  

9.2 效果：

表头1	表头2	表头3
内容	内容	内容
内容	内容	内容

left	center	right
aaaaa	bbbbb	ccccc
aa	bb	cc

10. 加入链接

10.1 说明：

若想加入超链接，可使用[Alt](URL "title")来实现，只是比上面插入图片的格式少了一个感叹号！，其他一样。

10.2 效果：

点我进入CSDN

11. 图片链接

11.1 说明：

有时候我们需要点击一张图片或图标，然后跳转到相应的链接，叫图片链接。基本格式待补充[![](图片地址)](链接网址)，特别注意半角输入，不能有全角输入。

11.2 效果：

（无，需要填写您Github中图片的地址或者是网站地址。）

12. 插入符号

12.1 说明：

为了实现符号列表，使文章更具有条理性，github支持圆点符号和正方形符号等。通常在编辑的时候用星号*[空格]来表示。若要实现二级圆点或三级圆点，只需多加一个Tab键就可以。

12.2 效果：

• 一级圆点
  • 二级圆点
    • 三级圆点
      • 四级圆点
        • 五级圆点

13. 复选列表

13.1 说明：

复选框列表的功能可用来标注各个项目的完成情况等，或者某个调查的多选情况。基本格式：

• 用-[空格][x][空格]我叫Alice表示选中
• 用-[空格][ ][空格]来自BUAA表示未选中。

13.2 效果：

• 我叫Alice
• 来自BUAA
• 我喜欢你
• 你喜欢我

14. 多级结构

14.1 说明：

我们需要使用类似树结构，并且实现分级时候，可以使用>[空格]来进行分级，其中对应多少>实现几级的树结构

14.2 效果：

一类树

二类树

三类树

四类树

15. 代码高亮

15.1 说明：

若需要添加代码的话，则只需在对应代码的前后加上三个反引号后加上对应编程语言就可以，大小写不用管，例如python语言就写python，c语言就写c。
例如实现python代码：

```python  
for i or range(10):  
    print(i)  
```

15.2 效果：

for i or range(10):
    print(i)  

16. 添加表情

16.1 说明：

Github的readme支持添加emoji表情，输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。下面我就简单列出常见的表情，另外其他表情可以通过查询Github官网表情

16.2 效果：

Syntax	Preview	Syntax	Preview
:blush:	😊	:kissing_closed_eyes:	😚
:smirk:	😏	:stuck_out_tongue_winking_eye:	😜
:sleeping:	😴	:satisfied:	😆
:smile:	😄	:smiley:	😃
:heart_eyes:	😍	:flushed:	😳
:grin:	😁	:worried:	😟

17. 使用锚点

17.1 说明：

往往看完了文档或者readme，这时候你需要一个一键返回顶部，基本格式为Loading…

17.2 效果：

Loading…

18. diff语法

18.1 说明：

一般diff功能可以实现一个文件内容的增添与删减操作。GFM中可以显示展示diff效果。基本格式：同样以三个反引号后面写diff，用+绿色开头表示新增，-红色开头表示删除，还有！黄色开头和#黑色开头。

```diff  
+ 大家好  
- 我叫Alice  
! 来自BUAA  
# 我很高兴认识你们！  

18.2 效果：

+ 大家好  
- 我叫Alice  
! 来自BUAA  
# 我很高兴认识你们！