markdown 语法及使用

186 阅读3分钟

为什么使用markdown?

markdown是最轻量的文字编辑语言,是一种标记语言
允许人们以纯文本的格式编写文档,当前很多网站、编辑器支持使用markdown来撰写文档。

markdown 语法

1. markdown 标题

一级标题的两种方式

  • # 一级标题
  • 一级标题
    ==========

二级标题的两种方式

  • ## 二级标题
  • 二级标题
    -----------

2. markdown 换行

2.1 每行后面加2个空格和一个回车

第一行 +(2个空格和1个回车)
第二行

每行后面加2个空格和一个回车的使用效果行1
每行后面加2个空格和一个回车的使用效果行2

2.2 两行之间加一个回车

第一行
1个回车
第二行

两行之间加一个回车的使用效果行1

两行之间加一个回车的使用效果行2

3. markdown 字体

*斜体*
**粗体**
***斜粗体***

斜体
粗体
斜粗体

4.markdown 分割线

用三个以上的星号、减号来建立一个分隔线,行内不能有其他东西

***
---



5. markdown 删除线

~~删除~~

删除

6. 下划线

<u>下划线</u>

7. 脚注

脚注[^markdown]

8. 列表

无序列表,使用 - * +
- 第一项
- 第二项

  • 第一项
  • 第二项

有序列表,数字加上空格加上.
1.空格第一项
2.空格第二项

  1. 第一项
  2. 第二项

9. markdown 列表嵌套

在子列表前面加4个空格

  1. 第一项
    - 第一项的嵌套1
    - 第一项的嵌套2
  2. 第二项
    1.空格第一项的嵌套1
    2.空格第一项的嵌套2
  1. 第一项
    • 第一项的嵌套1
    • 第一项的嵌套2
  2. 第二项
    1. 第一项的嵌套1
    2. 第一项的嵌套2

10.markdown 区块

> 外层一
> 外层二
>>第一层嵌套

外层一
外层二

第一层嵌套

11.区块中使用列表

> 外层一
> - 第一项
> - 第二项
> 1. 第三项
> 2. 第四项

外层一

  • 第一项
  • 第二项
  1. 第三项
  2. 第四项

12.列表种使用区块

- 第一项
> 区块1
>> 嵌套
> 区块2
- 第二项

效果如下:

  • 第一项

    区块1

    嵌套 区块2

  • 第二项

13.代码和代码段

`code`

`code`

```
code line1
code line2
```

code line1
code line2

14.链接

<链接地址>
juejin.cn/user/394024…

[链接名称](链接地址)
xc_oo

15.图片

![alt 属性](图片地址)
cicd.png

16.表格

| 标题 | 表头 |
| --- | --- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

标题表头
单元格单元格
单元格单元格

对齐方式 :- -: :-:

| 左对齐 | 右对齐 | 居中对齐 |
| :--- | ---: | :---: |
| 单元格11111111 | 单元格 | 单元格 |
| 单元格 | 单元格222222 | 单元格 |

左对齐右对齐居中对齐
单元格11111111单元格单元格
单元格单元格222222单元格

17.高级技巧

  • 支持html

  • 转义\
    \*\*正常显示星号\*\*
    效果为: **正常显示星号**

  • 公式
    $sin$
    sinsin

    $$ cos $$

    coscos

总结:一般在项目里都会有一个README.md文件,使用的就是markdown语法。