Markdown语法

Markdown语法


0. 目录

1. 标题语法

2. 段落语法

3. 换行语法

4. 强调语法

5. 引用语法

6. 列表语法

7. 代码语法

8. 分隔线语法

9. 链接语法

10. 图片语法

11. 转义字符语法

12. 表格

13. 脚注

14. 标题编号

15. 定义列表

16. 删除线

17. 任务列表

1. 标题语法

  1. 用不同数量的#来表示不同级别的标题,#越多,标题等级越小,或者可以在标题下方添加任意数量的==号来标识一级标题,或者--号来标识二级标题。

  2. 此外,#和标题之间应该使用一个空格。

2. 段落语法

  1. Markdown中使用空白行来分开段落。

  2. 此外,空格和TAB无法使段落缩进。

3. 换行语法

  1. 在段尾添加2个或者以上的空格,然后ENTER键即可换行。

  2. 或者可以使用HTML 的<br>标签,无需ENTER键。

4. 强调语法

  1. 斜体

    在需要设置斜体的内容部分俩头加上1个星号*或者1个下划线_。建议使用星号。

  2. 粗体

    在需要设置加粗的内容部分俩头加上2个星号**或者2个下划线__。建议使用星号。

  3. 斜体+粗体

    在需要设置加粗和斜体的内容部分俩头加上3个星号***或者3个下划线___。建议使用星号。

5. 引用语法

  1. 在段落前添加一个>符号,即可创建块引用。

  2. 块引用可以包含多个段落。段落之间的空白行须添加一个>符号。

  3. 支持嵌套使用,在要嵌套的段落前添加一个>>符号。

6. 列表语法

  • 有序列表

    数字并紧跟一个英文句点加空格。

  • 无序列表

    1. 使用破折号-星号*或加号+,然后一个空格 (不建议混合使用)。
    2. 缩进一个或多个列表项可创建嵌套列表(前面不能带有>,即块引用)。
  • 列表中嵌套其他元素

    可将元素缩进四个空格或一个制表符来保留列表连续性的同时在列表中添加这个元素。

7. 代码语法

  • 使用反引号`包裹词或短语将其表示为代码。如:

    `std`表示std

  • 要在表示为代码的单词或短语中包含反引号`,需要用双反引号``包裹这些单词或短语。如:

    `` I`m` `` I`m`

  • 在代码块之前和之后的行上使用三个反引号```或三个波浪号~~~即可创建代码块。

    或者将代码块的每一行缩进至少四个空格或一个制表符来创建代码块(不推荐)。

#include <stdio.h>

int main(int argc, char* argv[])
{
	printf("This is a demo.\n");

	return 0;
}

8. 分隔线语法

在单独一行上使用三个或多个星号***、三个或多个破折号---或三个或多个下划线___,并且不能包含其他内容即可创建分割线。

9. 链接语法

10. 图片语法

  • 插入图片: ![图片alt](图片链接 "图片title")



    与超链接相比,其仅在前面多了个!,且title同样可以省略

  • 超链接图片: [![图片alt](图片链接 "图片title")](超链接地址)



    实际就是把插入的图片当作超链接的显示名

11. 转义字符语法

  • 在字符前面添加反斜杠字符\来显示原本用于Markdown文档的字符

  • 可做转义的字符: ` \ * _ { } [ ] ( ) # + - . ! |

  • 特殊字符<和&

    1. <需要用&lt;来表示,注意不要丢掉分号;
    2. &需要用&amp;来表示,注意不要丢掉分号;

12. 表格

  1. 使用三个或多个连字符---创建每列的标题,并使用管道|分隔每列,表格前要空一行

    |标题1|标题2|

    |--------|-------|

    |文本1|文本2|

    |文本3|文本4|

    标题1 标题2
    文本1 文本2
    文本3 文本4
  2. 在标题行中的连字符左侧、右侧或左右侧同时添加冒号:来控制表格中的文本对其方式为左对齐、右对齐或居中

    | 左侧对齐 | 居中对齐 | 右侧对齐 |

    | :-----| :----: | ----: |

    | 单元格 | 单元格 | 单元格 |

    | 单元格 | 单元格 | 单元格 |

    左侧对齐 居中对齐 右侧对齐
    单元格 单元格 单元格
    单元格 单元格 单元格
  3. 可以使用表格的HTML字符代码&#124;在表中显示竖线|字符。

13. 脚注

  • 在需要添加脚注的地方添加[^ ]和标识符,标识符可以是数字和字母,但不能包含空格或制表符。

  • 然后在除列表,块引号和表之类的其他元素之外的任何位置,添加对应的脚注[^ ]+标识符+冒号:+空格 +内容

    如:

	In me the tiger sniffs[^1] the rose.[^2]

	[^1]: 嗅,闻。
	[^2]: 心有猛虎,细嗅蔷薇。

效果:

In me the tiger sniffs[1] the rose.[2]

14. 标题编号

  • 在标题后添加{#id},然后在需要添加链接的地方加上[HeadingName](#id)(某些Markdown处理器不支持),如:
### Example {#123}
[Example](#123)

Example

Example

15. 定义列表

在第一行上键入术语。在下一行,键入一个冒号:,后跟一个空格 加定义。(某些Markdown处理器不支持,且前一行需要是空白行)

如:

等边三角形
: 三条边都相等的三角形

等边三角形
三条边都相等的三角形

16. 删除线

在单词前后使用两个波浪号~~即可添加删除线。如:

~~Text~~

Text

17. 任务列表

破折号-加空格 加包含一对空格的中括号[ ]加空格 加内容,在方括号[ ]之间添加x可以选中复选框如:

	- [ ] Text1<br>
	- [ ] Text2<br>
	- [x] Text3<br>

效果:


  1. 嗅,闻。 ↩︎

  2. 心有猛虎,细嗅蔷薇。 ↩︎

posted @ 2024-09-08 20:05  决云  阅读(94)  评论(0)    收藏  举报