基本语法
原始设计文档中概述的 Markdown 元素。
概述
几乎所有 Markdown 应用程序都支持原始 Markdown 设计文档中概述的基本语法。Markdown 处理器之间存在细微的差异和出入,这些差异和出入在可能的情况下都会以内联方式注明。
标题
要创建标题,请在单词或短语前添加井号 (#
)。井号的数量应与标题级 别相对应。例如,要创建三级标题 (<h3>
),请使用三个井号(例如,### 我的标题
)。
Markdown | HTML | 呈现的输出 |
---|---|---|
# 一级标题 | <h1>一级标题</h1> | 一级标题 |
## 二级标题 | <h2>二级标题</h2> | 二级标题 |
### 三级标题 | <h3>三级标题</h3> | 三级标题 |
#### 四级标题 | <h4>四级标题</h4> | 四级标题 |
##### 五级标题 | <h5>五级标题</h5> | 五级标题 |
###### 六级标题 | <h6>六级标题</h6> | 六级标题 |
备用语法
或者,在文本下方的行中,添加任意数量的 == 字符以表示一级标题,或 -- 字符以表示二级标题。
Markdown | HTML | 呈现的输出 |
---|---|---|
一级标题 =============== | <h1>一级标题</h1> | 一级标题 |
二级标题 --------------- | <h2>二级标题</h2> | 二级标题 |
标题最佳实践
Markdown 应用程序对于如何处理井号 (#
) 和标题名称之间的空格没有达成一致。为了兼容性,请始终在井号和标题名称之间添加一个空格。
✅ 执行此操作 | ❌ 不要执行此操作 |
---|---|
# 这是一个标题 | #这是一个标题 |
为了兼容,您还应在标题前后放置空行。
✅ 执行此操作 | ❌ 不要执行此操作 |
---|---|
尝试在...前放置空行 # 标题 ...并在标题后放置空行。 | 如果没有空行,可能看起来不正确。 # 标题 不要这样做! |
段落
要创建段落,请使用空行分隔一行或多行文本。
Markdown | HTML | 呈现的输出 |
---|---|---|
我真的很喜欢使用 Markdown。 我想从现在开始使用它来格式 化我所有的文档。 | <p>我真的很喜欢使用 Markdown。</p> <p>我想从现在开始使用它来格式 化我所有的文档。</p> | 我真的很喜欢使用 Markdown。 我想从现在开始使用它来格式 化我所有的文档。 |
段落最佳实践
除非 段落位于列表中,否则不要使用空格或制表符缩进段落。
注意:如果您需要在输出中缩进段落,请参阅有关如何 缩进(制表符) 的部分。
✅ 执行此操作 | ❌ 不要执行此操作 |
---|---|
不要在段落前放置制表符或空格。 保持行左对齐,如下所示。 | 这可能会导致意外的格式问题。 不要在段落前添加制表符或空格。 |
换行
要创建换行或新行 (<br>
),请使用两个或更多空格结束一行,然后键入回车。
Markdown | HTML | 呈现的输出 |
---|---|---|
这是第一行。 这是第二行。 | <p>这是第一行。<br> 这是第二行。</p> | 这是第一行。 这是第二行。 |
换行最佳实践
您可以在几乎每个 Markdown 应用程序中使用两个或更多空格(通常称为“尾随空格”)进行换行,但这存在争议。在编辑器中很难看到尾随空格,许多人会在每个句子后意外或故意放置两个空格。因此,您可能希望使用尾随空格以外的东西进行换行。如果您的 Markdown 应用程序 支持 HTML,则可以使用 <br>
HTML 标记。
为了兼容,请在行尾使用尾随空格或 <br>
HTML 标记。
还有两个我不推荐使用的选项。CommonMark 和其他一些轻量级标记语言允许你在行尾输入一个反斜杠 (),但并非所有 Markdown 应用程序都支持此功能,因此从兼容性的角度来看,这不是一个好选项。至少有几种轻量级标记语言不需要在行尾输入任何内容——只需按回车,它们就会创建一个换行符。
✅ 执行此操作 | ❌ 不要执行此操作 |
---|---|
后跟两个空格的第一行。 以及下一行。 后跟 HTML 标签的第一行。<br> 以及下一行。 | 后跟反斜杠的第一行。\ 以及下一行。 后跟空内容的第一行。 以及下一行。 |
强调
你可以通过加粗或斜体文本来添加强调。
加粗
要加粗文本,请在单词或短语前和后添加两个星号或下划线。要加粗单词中间的内容以示强调,请在字母周围添加两个星号,中间不要有空格。
Markdown | HTML | 呈现的输出 |
---|---|---|
我非常喜欢 **加粗文本**。 | 我非常喜欢 <strong>加粗文本</strong>。 | 我非常喜欢 加粗文本。 |
我非常喜欢 __加粗文本__。 | 我非常喜欢 <strong>加粗文本</strong>。 | 我非常喜欢 加粗文本。 |
Love**is**bold | Love<strong>is</strong>bold | Loveisbold |
加粗最佳实践
Markdown 应用程序对于如何处理单词中间的下划线没有达成一致意见。为了兼容性,请使用星号加粗单词中间的内容以示强调。
✅ 执行此操作 | ❌ 不要执行此操作 |
---|---|
Love**is**bold | Love__is__bold |
斜体
要将文本斜体化,请在单词或短语前和后添加一个星号或下划线。要斜体化单词中间的内容以示强调,请在字母周围添加一个星号,中间不要有空格。
Markdown | HTML | 呈现的输出 |
---|---|---|
斜体文本是 *cat's meow*。 | 斜体文本是 <em>cat's meow</em>。 |