Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

Markdown具有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,它们能让Markdown转换成更多的格式,例如LaTeX,Docbook。

Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具,如Pandoc;要么基于网站,如GitHub和Wikipedia,在语法上基本兼容,但在一些语法和渲染效果上有改动。

因为增强版等存在不同软件和网站有各自特殊的语法规则,本文档仅整理常用的通用规则。


Markdown 标题

顶格使用 # 标记,并在#号后加入1个空格,根据空格前的#数量确定标题的级数

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

标题分为四级:

  • 一级标题:文章的标题
  • 二级标题:文章主要部分的大标题
  • 三级标题:二级标题下面一级的小标题
  • 四级标题:三级标题下面某一方面的小标题

标题使用原则:

一级标题下,不能直接出现三级标题。示例:下面的文章结构,缺少二级标题。

1
2
3
# 一级标题

### 三级标题

标题要避免孤立编号(即同级标题只有一个)。示例:下面的文章结构,二级标题 A只包含一个三级标题,完全可以省略三级标题 A

1
2
3
4
5
## 二级标题 A

### 三级标题 A

## 二级标题 B

下级标题不重复上一级标题的名字。示例:下面的文章结构,二级标题与下属的三级标题同名,建议避免。

1
2
3
## 概述

### 概述

谨慎使用四级标题,尽量避免出现,保持层级的简单,防止出现过于复杂的章节。如果三级标题下有并列性的内容,建议只使用项目列表(Item list)。示例:下面的结构二要好于结构一。结构一适用的场景,主要是较长篇幅的内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
结构一

### 三级标题

#### 四级标题 A

#### 四级标题 B

#### 四级标题 C

结构二

### 三级标题

**(1)A**

**(2)B**

**(3)C**

Markdown 文本

通过*_对文本的包围使用可以实现以下几种效果

1
2
3
4
5
6
7
8
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
~~删除线~~
`代码`

若单使用*** ---可实现如下分隔线的效果


此外使用Html标签中的<u>下划线</u> 实现下划线效果

该网站修改下划线效果,改成如下样式:下划线。以实现遮盖效果

Markdown 列表

列表分为无序和有序两种,实现起来也非常简单

无序列表:使用星号(*)、加号(+)或是减号(-)作为列表标记:

1
2
3
* 123
+ 456
- 789

但为了方便修改,建议一篇文档只使用一种实现方式,推荐统一使用+来实现


有序列表:1.只需在数字后加上半角句号并添加一个空格即可实现

1
2
3
1. a
2. b
3. c

列表之间可以相互嵌套,但要注意层次间的缩进

1
2
3
1. 第一项:
+ 第一项嵌套的第一个元素
+ 第一项嵌套的第二个元素

Markdown 区块

区块使用>符号加空格实现,同样可以进行嵌套

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

最外层

第一层嵌套

第二层嵌套

Markdown 代码

printf() 所示,表示代码,使用该符号`(键盘上在数字1前)将内容包裹

连续的3个反单引号包裹的片段就可以,实现代码块样式

1
2
3
```python
print("Hello,world!")
```

Markdown 链接

使用该形式[链接名称](链接地址)可创建一个链接

这是一个链接百度

Markdown 图片

Markdown

上图的实现方法

1
![Markdown](https://pic.downk.cc/item/5fe748a83ffa7d37b3ef621f.jpg "Hello")

![图名](图片地址)

![图名](图片地址 "可选标题")

开头一个感叹号!,接着一个方括号,里面放上图片的替代文字,接着一个普通括号,里面放上图片的网址(或者本地文件地址),最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。

Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 <img> 标签

Markdown 表格

1
2
3
4
|  表头   | 表头  |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
表头 表头
单元格 单元格
单元格 单元格
  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。
1
2
3
4
| 左对齐 | 右对齐 | 居中对齐 |
| :----- | -----: | :------: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

Latex

https://www.zybuluo.com/codeep/note/163962

参考资料: