Markdown学习笔记

标题语法

标准语法

要创建标题，只需要在单词或者短语钱添加井号#。

井号的个数代表标题的级别，支持 1~6 个级别

可选语法

可以在文本下方添加任意数量的 = 号来标识一级标题，或者 - 号来标识二级标题

最佳实践

为了兼容各类应用程序 # 和标题之间使用一个空格来分割

段落

(段落1)使用空白行分割两个段落

(段落2)一个段落里可以有多行文本哈！
我是第二行

最佳实践

不要使用空格和制表符锁紧段落！

换行

在一个段落里需要换行时，
可以在一行的末尾添加两个或多个空格，
然后按回车键即可创建一个换 <br>。

最佳实践

使用结尾空格来实现换行，很难在编辑器中看的出来，某一行里存在结尾空格，

可以使用html中的<br>标签，显性添加换行。这种方式会更友好。
使用这种方式还可以在行中间添加换行

强调

粗体

要加粗文本（包括单词、短语或单词的中间部分），请在单词或短语前后各添加 两个 星号*或下划线_。

最佳实践

Markdown应用程序在处理单词中间部分的下划线时，不太一致，为了兼容考虑，单词中间加粗的话，请使用星号*。

斜体

要用斜体显示文本（包括单词、短语或单词的中间部分），请在单词或短语前后添加 一个 星号*或下划线_。

最佳实践

同 粗体 的最佳实践

粗斜体

要用粗斜体显示文本（包括单词、短语或单词的中间部分），请在单词或短语前后添加 三个 星号*或下划线_。

最佳实践

同 粗体 的最佳实践

删除线

若要删除单词，请在单词前后使用两个波浪号~~。

引用

要创建块引用，请在段落前添加一个 > 符号。

块引用里可以支持 其他类型的markdown语法，包括块引用，标题，列表，段落，强调等。

列表

可以将多个条目组织成有序或无序列表

有序列表

要创建有序列表，请在每一个列表项前添加数字并紧跟一个英文句点。数字不必须按数字顺序排列，但是列表应当以数字1开始

无序列表

要创建无序列表，请在每个列表项前面添加破折号-、星号* 或加号+ 。缩进一个或多个列表项可创建嵌套列表。

最佳实践

对于不同的无序列表可以使用不同的前缀，但是在一个无序列表中最好不要混用前缀。

嵌套其他元素

要在保留列表连续性的同时在列表中添加另一种元素，请将该元素缩进四个空格或一个制表符，且该元素前后行各保留一个空行。

可以嵌套的其他元素如：段落，引用块，代码块，图片，列表等

1. 我是第一项

   测试嵌套

2. 我是第二项

代码块

行内代码

将单词或代码关键词，包裹在反引号`中

转义反引号

如果你要表示为代码的单词或短语中包含一个或多个反引号，则可以通过将单词或短语包裹在双反引号``中。

行间代码

在代码块之前和之后的行上使用三个反引号```或者波浪号~~~；

语法高亮

可以在代码块之前的反引号后面指定语言名称，来实现语法高亮，例如java，sql，json等

表格

要添加表，请使用三个或多个连字符---创建每列的标题，并使用管道|分隔每列。您可以选择在表的任一端添加管道。

对齐

您可以通过在标题行中的连字符的左侧，右侧或两侧添加冒号:，将列中的文本对齐到左侧，右侧或中心。

分割线

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

最佳实践

为了兼容性，请在分隔线的前后均添加空白行。

表格生成器

表格生成页面

链接

超链接

超链接语法为:

[超链接显示名](超链接地址 "超链接title")

其中超链接title是可选；

超链接样例： 参考文档

网址和Email地址

使用尖括号可以很方便地把URL或者email地址变成可点击的链接。

https://markdown.com.cn/basic-syntax/

最佳实践

不同的 Markdown 应用程序处理URL中间的空格方式不一样。为了兼容性，请尽量使用%20代替空格。

标题编码

要添加自定义标题ID，请在与标题相同的行上用大括号括起该自定义ID。语法：

## 标题编码 {#headid}

链接到标题ID

语法：

[名称](#标题ID)

转义字符

要显示原本用于格式化 Markdown 文档的字符，请在字符前面添加反斜杠字符\。