您的位置:

语雀Markdown完全指南

一、Markdown简介

Markdown是一种轻量级标记语言,设计初衷是让人们更容易书写结构化的文档,而不是让人们更关注排版的问题。Markdown最初由约翰·格鲁伯(John Gruber)于2004年创建,是一种以易读、易写的方式书写文本的语法。

Markdown语言可以转换成HTML、PDF等多种格式。Markdown语言的标记语法主要包括:标题、段落、列表、表格、代码块、链接、图片等。语法简单,但涵盖了绝大多数文本排版所需的功能。

二、语雀Markdown概述

语雀是一个在线的文本编辑和协作平台。语雀支持Markdown语言,并针对Markdown进行了优化。相比于传统的Markdown语法,语雀 Markdown 在语法上进行了一些扩展、优化,例如增加了插图、公式、文档目录等高级功能,还支持各类自定义样式和模板。

在语雀Markdown中,标题、段落、列表、表格等基本语法和一般的Markdown语法类似。下面我们来介绍一些语雀Markdown的特殊语法。

三、语雀Markdown特殊语法

1.文档/目录

语雀Markdown支持一键生成完备的文档目录,用户在阅读大文档时可以快速定位到相关部分。在文档中插入[TOC]标签,语雀会自动生成该文档下的全部标题,并按照层级关系列出,形成一个可聚合、可收缩的列表。如下是一份自动文档目录创建的示例:


# 标题1
## 标题1.1
### 标题1.1.1
# 标题2
## 标题2.1

在文本中插入[TOC],语雀会自动生成文档目录:

[TOC]

2.表格

语雀Markdown对表格的支持也有所扩展,可以设置表格的列宽、对齐方式、背景色、单元格脚注等。下面我们来看一下如何在语雀Markdown中实现多种表格设定。

2.1 基本表格

| 左对齐 | 居中 | 右对齐 |
| :- | :-: | -: |
| a | b | c |
| aaa | bbb | ccc |

渲染效果如下:

| 左对齐 | 居中 | 右对齐 | | :- | :-: | -: | | a | b | c | | aaa | bbb | ccc |
2.2 添加背景色

| 姓名 | 性别 | 年龄 |
| :--- | :---: | ---: |
| **张三** | 女 | `18` |
| 李四 | 男 | `20` |

渲染效果如下:

| 姓名 | 性别 | 年龄 | | :--- | :---: | ---: | | **张三** | 女 | `18` | | 李四 | 男 | `20` |
2.3 设置单元格脚注

| 左对齐 | 居中 | 右对齐 |
| :- | :-: | -: |
| a | b | c |
| aaa | bbb | ccc[^1] |
[^1]: 这是注脚文字。

渲染效果如下:

| 左对齐 | 居中 | 右对齐 | | :- | :-: | -: | | a | b | c | | aaa | bbb | ccc[^1] |

3.公式

语雀Markdown支持通过MathJax插件实现Latex公式的渲染。添加公式只需要将其写在一对`$`符号之间,如 `$a^2 + b^2 = c^2$` 可渲染为:$a^2 + b^2 = c^2$。

如果需要在一行中轮廓多个公式,可以用 `$$` 符号,如 `$$a_{n+1} = a_n + d$$ $$S_n = \frac{(a_1 + a_n)n}{2}$$` 可渲染为:

$$a_{n+1} = a_n + d$$$$S_n = \frac{(a_1 + a_n)n}{2}$$

4.流程图和时序图

在语雀Markdown中,也支持通过Mermaid的较简短语法实现流程图和时序图的渲染。

4.1 流程图

```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```

渲染效果如下:

```mermaid graph TD; A-->B; A-->C; B-->D; C-->D; ```
4.2 时序图

```mermaid
sequenceDiagram
A->>B: 请求登录
B->>C: 验证参数
C->>D: 查询权限
alt 权限通过
D-->>B: 返回token
else 权限失败
D-->>A: 返回错误信息
end
```

渲染效果如下:

```mermaid sequenceDiagram A->>B: 请求登录 B->>C: 验证参数 C->>D: 查询权限 alt 权限通过 D-->>B: 返回token else 权限失败 D-->>A: 返回错误信息 end ```

总结

语雀Markdown作为一种轻量级标记语言,兼具Markdown语法的简单明了、易读易写的特点,并为用户提供了更多的扩展功能。熟练掌握语雀Markdown的语法和特性不仅可以大幅度提升文档编写的效率,还可以让你获得一个简洁、清晰、美观的文档。