GitHub之README.md编写技巧

一、标题写法

第一种方法

  1. 在文本下面加上 等于 = ,那么上方的文本就变成了大标题。等于 的个数无限制,但一定要大于0个哦。
  2. 在文本下面加上 下划线 – ,那么上方的文本就变成了中标题,同样的 下划线个数无限制。
  3. 要想输入= ,上面有文本而不让其转化为大标题,则需要在两者之间加一个空行。

第二种方法

关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。

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

语法:

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

字体格式强调

我们可以使用下面的方式给我们的文本添加强调的效果

语法:

*强调* (示例:斜体)

_强调_ (示例:斜体)

**加重强调** (示例:粗体)

__加重强调__ (示例:粗体)

***特别强调*** (示例:粗斜体)

___特别强调___ (示例:粗斜体)

展示:

强调 (示例:斜体)

强调 (示例:斜体)

加重强调 (示例:粗体)

加重强调 (示例:粗体)

特别强调 (示例:粗斜体)

特别强调 (示例:粗斜体)

代码

语法:

`<hello world>`

展示:

<hello world>

代码块高亮

def test():

print(‘hello world’)

test()

表格(建议在表格前空一行,否则可能影响表格无法显示)

语法:

表头 | 表头 | 表头

—- | —– | ——

单元格内容 | 单元格内容 | 单元格内容

单元格内容 | 单元格内容 | 单元格内容

展示:

其他引用

图片

语法:![图片名称](

https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cuYmFpZHUuY29tL2ltZy9iZF9sb2dvMS5wbmc?x-oss-process=image/format,png)

展示:

链接

  • 语法:[链接名称](https://www.baidu.com/)
  • 列表

    语法:

    1. 项目1

    2. 项目2

    3. 项目3

    * 项目1

    * 项目2

    换行(建议直接在前一行后面补两个空格)

    直接回车不能换行,

    可以在上一行文本后面补两个空格,

    这样下一行的文本就换行了。

    或者就是在两行文本直接加一个空行。

    也能实现换行效果,不过这个行间距有点大。

    引用

    语法:

    > 引用文字

    展示:

    引用文字

    声明:本站部分文章及图片源自用户投稿,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!

    上一篇 2022年9月21日
    下一篇 2022年9月21日

    相关推荐