Markdown 基本语法

发表于 分类于 阅读次数： 本文字数： 1.7k 阅读时长 ≈ 6 分钟
标题、强调、列表、块引用、代码、分割线、链接、图片

总览

几乎所有 Markdown 应用程序都支持 John Gruber 原始设计文档中列出的 Markdown 基本语法。

标题

要创建标题，请在单词或短语前面添加井号 (#) 。井号的数量代表了标题的级别。

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

示例

#### 标题4
##### 标题5
###### 标题6

效果

标题4

标题5
标题6

最佳实践

当井号（#）和标题文本之间没有空格时，各 Markdown 应用程序的处理方式是不一样的。为了兼容考虑，请在井号和标题文本之间添加一个空格。

强调

通过将文本设置为粗体或斜体来强调其重要性。

要加粗文本，请在单词或短语的前后各添加两个星号（ asterisks ）或下划线（ underscores ）。如需加粗一个单词或短语的中间部分用以表示强调的话，请在要加粗部分的两侧各添加两个星号（ asterisks ）。

要用斜体显示文本，请在单词或短语前后添加一个星号（ asterisk ）或下划线（ underscore ）。要斜体突出单词的中间部分，请在字母前后各添加一个星号，中间不要带空格。

要同时用粗体和斜体突出显示文本，请在单词或短语的前后各添加三个星号或下划线。要加粗并用斜体显示单词或短语的中间部分，请在要突出显示的部分前后各添加三个星号，中间不要带空格。

示例

**这是加粗的文字**
__这是加粗的文字__
这是**加粗**的文字
*这是倾斜的文字*
_这是倾斜的文字_
这是*倾斜*的文字
***这是加粗斜体的文字***
___这是加粗斜体的文字___
__*这是加粗斜体的文字*__
**_这是加粗斜体的文字_**
这是***加粗斜体***的文字

效果

这是加粗的文字
这是加粗的文字
这是加粗的文字
这是倾斜的文字
这是倾斜的文字
这是倾斜的文字
这是加粗斜体的文字
这是加粗斜体的文字
这是加粗斜体的文字
这是加粗斜体的文字
这是加粗斜体的文字

最佳实践

Markdown 应用程序在如何处理单词或短语中间的下划线上并不一致。为兼容考虑，在单词或短语中间部分加粗的话，请使用星号（ asterisks ）。

Markdown 的众多应用程序在如何处理单词中间的下划线上意见不一致。为了兼容起见，请用星号标注单词中间的斜体来表示着重。

Markdown 应用程序在处理单词或短语中间添加的下划线上并不一致。为了实现兼容性，请使用星号将单词或短语的中间部分加粗并以斜体显示，以示重要。

列表

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

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

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

如果你需要以数字开头并且紧跟一个英文句号（也就是 .）的无序列表项，则可以使使用反斜线（\）来 转义 这个英文句号。

示例

1. Red
2. Green
3. Blue

1. Red
1. Green
1. Blue

1. Red
4. Green
9. Blue

1. Red
2. Green
1. Green 1
2. Green 2
3. Blue

- Red
- Green
- Blue

* Red
* Green
* Blue

+ Red
+ Green
+ Blue

- Red
- Green
- Green 1
- Green 2
- Blue

- 1989\. 最好的一年
- 2019\. 第二好的一年

效果

  1. Red
  2. Green
  3. Blue
  1. Red
  2. Green
  3. Blue
  1. Red
  2. Green
  3. Blue
  1. Red
  2. Green
    1. Green 1
    2. Green 2
  3. Blue
  • Red
  • Green
  • Blue
  • Red
  • Green
  • Blue
  • Red
  • Green
  • Blue
  • Red
  • Green
    • Green 1
    • Green 2
  • Blue
  • 1989. 最好的一年
  • 2019. 第二好的一年

最佳实践

CommonMark 和其它几种轻量级标记语言可以让你使用括号（)）作为分隔符（例如 1) Red），但并非所有的 Markdown 应用程序都支持此种用法，因此，从兼容的角度来看，此用法不推荐。为了兼容起见，请只使用英文句点作为分隔符。

Markdown 应用程序在如何处理同一列表中混用不同分隔符上并不一致。为了兼容起见，请不要在同一个列表中混用不同的分隔符，最好选定一种分隔符并一直用下去。

块引用

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

块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号。

块引用可以包含其他 Markdown 格式的元素。

示例

>这是引用的内容
>
>>这是引用的内容
>>
>>>这是引用的内容

>## 标题2
>- Red
>- Green
>- Blue
>
>这是**加粗***斜体**的文字

效果

这是引用的内容

这是引用的内容

这是引用的内容

这是引用的内容

  • Red
  • Green
  • Blue

这是加粗*斜体**的文字

最佳实践

为了兼容性，请在块引号之前和之后放置空行。

代码

要将单词或短语表示为代码，请将其包裹在反引号 ( ` ) 中。

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

要创建代码块，请将代码块的每一行缩进至少四个空格或一个制表符。

示例

#include <stdio.h>
int main() {
// 打印 Hello, World!
printf("Hello, World!\n");
return 0;
}

效果

#include <stdio.h>
int main() {
    // 打印 Hello, World!
    printf("Hello, World!\n");
    return 0;
}

分割线

示例

---
- - - - -
***
*****
___
_____

效果

链接

要创建链接，请将链接文本括在方括号中，后面紧跟着括在圆括号中的 URL（例如 (https://blog.mhxcalfred.com) ）。

示例

我的网站 [胡心小筑](https://blog.mhxcalfred.com)。

效果

我的网站 胡心小筑。

图片

要添加图片，首先请添加感叹号（!），然后紧跟着是方括号，方括号中可添加替代文本（alt text，即图片显示失败后显示此文本），最后跟着圆括号，圆括号中添加图片资源的路径或 URL。你可以选择在圆括号中的 URL 之后添加标题（即 title 属性）。

示例

![测试](201911200001.jpg)
{% asset_img 201911200001.jpg 测试 %}

效果

测试