Skip to content

Markdown 语法参考

Yank Note 使用 markdown-it 作为 Markdown 的解析器。默认支持 CommonMark 的语法标准。除此之外,Yank Note 还扩展了一些语法解析,使其支持支持遵守GitHub Flavored Markdown 所定义的表格、待办任务等语法解析。

常用语法

如果你刚开始接触 Markdown,下面的一些语法可以帮助你快速上手。如果你需要学习更多的语法,可以查看 Markdown Guide

标题

Markdown 支持 6 级标题。一般来说,一个文档应当只有一个一级标题。

markdown
# 这是一级标题

## 这是二级标题

### 这是三级标题

#### 这是四级标题

##### 这是五级标题

###### 这是六级标题

段落

Markdown 中,使用一个或多个空白行来区分段落

markdown
这是第一段的内容

这是第二段的内容

这是第三段的内容

引用

Markdown 中,使用 > 来表示引用

markdown
> 这是一些引用内容第一段
> 这是一些引用内容第一段
> 
> 这是一些引用内容第二段

有序列表

markdown
1. 第一项
2. 第二项
    1. 第二项的第一项
    2. 第二项的第二项
3. 第三项

无序列表

markdown
- 第一项
- 第二项
    - 第二项的第一项
    - 第二项的第二项
- 第三项

待办列表

markdown
- [ ] 未完成的任务
- [x] 已完成的任务

代码块

markdown
```javascript
function hello() {
    console.log('Hello World');
}
```

表格

markdown
| 项目 | 价格 | 数量 |
| ---- | ---- | ---- |
| 手机 | 1000 | 1    |
| 电脑 | 2000 | 2    |

数学公式

markdown
$$
\begin{array}{c}
\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} &
= \frac{4\pi}{c}\vec{\mathbf{j}}    \nabla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\
\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\
\nabla \cdot \vec{\mathbf{B}} & = 0
\end{array}
$$

水平线

markdown
---

文本样式

markdown
1. **加粗文本**
2. *斜体文本*
3. `行内代码`
4. ~~删除线~~

链接

markdown
[链接文字](http://example.com)

图片

markdown
![图片描述](http://example.com/image.jpg)

高级语法

除了 CommonMark 和 GFM 的语法标准外,Yank Note 还支持一些高级语法,用来增强文档的表现力。

您可以在 Yank Note 应用中状态栏帮助->特色功能说明中找到并参考。

注意:部分语法(如 Mermaid 解析)需要安装对应的扩展来实现