Markdown 进阶
这篇教程介绍本站支持的增强写法,包括 Mermaid 图表、KaTeX 数学公式、上下标和脚注。所有示例均可直接复制到编辑区使用。
Mermaid 图表
本站可以把标记为 mermaid 的代码块渲染成图表。图表第一行使用 flowchart 声明布局方向,常用方向包括从左到右的 LR 和从上到下的 TD。
节点的基本写法是 标识[显示文字],使用 --> 连接两个节点。标识只用于建立连接,方括号中的文字才会显示在图中。
流程图
流程图适合表现操作步骤、判断条件和不同结果。花括号节点表示判断,连接线中间的 |文字| 用来标注分支条件。
```mermaid
flowchart TD
Start([开始]) --> Write[编写内容]
Write --> Check{检查通过?}
Check -->|是| Publish[发布文档]
Check -->|否| Revise[修改内容]
Revise --> Check
Publish --> End([结束])
```
实际效果:
鱼骨图
鱼骨图用于从多个方向分析问题原因。本站使用兼容的流程图语法模拟鱼骨结构:横向链条作为主骨,各类原因连接到对应骨节,最终汇入结果。
```mermaid
flowchart LR
Bone1(( )) --> Bone2(( )) --> Bone3(( )) --> Result[产品质量不稳定]
People[人员:培训不足] --> Bone1
Material[材料:批次波动] --> Bone1
Method[方法:流程不清] --> Bone2
Machine[设备:维护不足] --> Bone2
Measure[测量:标准不一] --> Bone3
Environment[环境:温湿度变化] --> Bone3
```
实际效果:
思维导图
思维导图用于围绕一个中心主题展开分支。中心节点使用双圆括号突出显示,再逐层连接主题和细节。
```mermaid
flowchart TD
Root((内容计划))
Root --> Goal[目标]
Root --> Audience[读者]
Root --> Structure[结构]
Goal --> Explain[解释概念]
Goal --> Guide[指导操作]
Audience --> Beginner[初学者]
Audience --> Team[团队成员]
Structure --> Intro[开场]
Structure --> Body[正文]
Structure --> Summary[总结]
```
实际效果:
上标
使用一对 ^ 包住上标内容,定界符内侧不要留空格。
30^th^ 以及 x^2^
实际效果:30th 以及 x2。
下标
使用一对 ~ 包住下标内容,定界符内侧不要留空格。
H~2~O 以及 CO~2~
实际效果:H2O 以及 CO2。
数学公式
数学公式使用 LaTeX 写法,并由本站直接渲染。简单公式放在一对 $ 中;需要独占一行的推导或较长公式使用一对 $$。
公式中的 ^ 和 _ 分别表示数学上标与下标。如果上标或下标包含多个字符,需要使用花括号,例如 x^{10} 和 a_{n+1}。这与上一节普通文字使用的 ^上标^、~下标~ 写法不同。
行内公式
行内公式可以自然地放在句子中,定界符与公式之间不要换行。
质能方程 $E = mc^2$,圆的面积 $S = \pi r^2$,数列项为 $a_{n+1}$。
实际效果:质能方程
块级公式
块级公式适合分式、求和、积分和推导。开始与结束的 $$ 各自单独占一行。
$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$
实际效果:
多行公式
使用 aligned 环境对齐多行等式,& 标记对齐位置,\\ 开始新的一行。
$$
\begin{aligned}
(a+b)^2 &= a^2 + 2ab + b^2 \\
(a-b)^2 &= a^2 - 2ab + b^2
\end{aligned}
$$
实际效果:
常用写法
| 目标 | 写法 | 效果 |
|---|---|---|
| 分式 | \frac{a}{b} |
|
| 根号 | \sqrt{x} |
|
| 求和 | \sum_{i=1}^{n} i |
|
| 积分 | \int_0^1 x^2\,dx |
|
| 希腊字母 | \alpha, \beta, \pi |
如果正文需要显示普通美元符号,请写成 \$,避免被识别为公式定界符。公式语法有误时,预览区会显示错误信息并可定位到对应源码。
脚注
正文中的 [^名称] 是脚注标记,文档其他位置的 [^名称]: 用来填写脚注内容。名称只用于对应两处,不会显示给读者。
这句话需要一条补充说明。[^note]
[^note]: 这里是脚注内容。
实际效果如下。点击脚注编号会跳到页面底部,点击返回符号可以回到正文。
这句话需要一条补充说明。[1]
这里是脚注内容。 ↩︎