本页目录
> 资源 > 文档 > 流程仪表板 > Markdown语法速查指南

Markdown语法速查指南

Markdown 语法手册（快速参考与示例）

请参考本指南美化您的文本图表内容。ProcessMind 支持CommonMark基础语法及主流**GitHub-Flavored Markdown (GFM)**扩展，包括表格、任务清单和删除线。

标题

用 # 至 ###### 行首表示不同级别标题：

# H1
##  H2
###  H3
####  H4
#####  H5
######  H6

段落与换行

用空行分隔段落。

软换行（单行换行）：行尾输入两个空格或 <br>。

First line with a soft break··
continues on the next line.

New paragraph after a blank line.

强调（斜体、粗体、删除线）

*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~   <!-- GFM -->

列表（无序、有序、嵌套）

无序列表用：-、+、*，有序列表用：1.、2.等。

- Item A
- Item B
  - Nested item B1
  - Nested item B2

1. Step one
2. Step two
   1. Sub-step
   2. Sub-step

提示： 嵌套项请统一缩进2～4个空格。

链接

支持行内与引用式两种写法：

Inline: [ProcessMind](https://processmind.com)
With title: [Site](https://example.com "Optional title")

Reference: [Docs][docs-link]

[docs-link]: https://example.com/docs

图片

alt文本有助提升可访问性和搜索效果。

![Alt text describing the image](https://example.com/image.png "Optional title")

引用形式插图：

![Logo][logo]

[logo]: https://example.com/logo.png

引用块

用 > 放在行首表示引用，多重 > 表示嵌套。

> A single-line quote.
>
> Multi-paragraph quote:
>
> > Nested quote level 2.

代码（行内与块）

行内代码用反引号 `，代码块用三个反引号围起。可加编程语言实现高亮。

代码块使用三反引号包裹。添加语言名称以启用语法高亮。

  • 示例 ```代码
Here’s `inline code`.

如果内容本身包含三反引号，请使用 四 个反引号进行包裹。

水平分割线

在一行中单独使用三个或更多 ---、*** 或 ___：

---

表格

使用竖线 | 和表头分隔符 ---。冒号 (:) 用于设置对齐方式。

| Column        | Type    | Notes              |
|:--------------|:-------:| :------------------|
| Name          | String  | Left-aligned       |
| Score         | Number  | Left-aligned       |
| Description   | String  | Left-aligned       |
列类型备注
名称String左对齐
分数Number左对齐
描述String左对齐

在表格前添加空行有助于部分解析器正确渲染。

任务列表

使用 - [ ] 和 - [x]。

- [x] Design schema
- [ ] Implement API
- [ ] Write tests
  • 设计架构
  • 实现 API
  • 编写测试

转义特殊字符

在字符前添加反斜杠 \ 以渲染原义字符。

\*Not italic\*, show the asterisks literally.
Use a backslash for \#, \[, \], \(, \), \_, \*, \`, \|, \>

引用式链接与图片

将引用集中在底部，使内容更简洁。

Read the [Guide][g].
See the ![Badge][b].

[g]: https://example.com/guide
[b]: https://example.com/badge.svg

自动链接与电子邮件

裸 URL 通常会自动转换为链接。使用尖括号可以强制转换。

https://example.com
<mailto:hello@example.com>

行内 HTML（可选）

当 Markdown 功能不足时，大多数渲染器允许使用安全的行内 HTML。

<strong>Bold</strong> and <em>italic</em> with HTML.
<br>
<span style="font-variant:small-caps">Small caps</span>

注意：出于安全和兼容性考虑，并非支持所有 HTML 标签。

常见陷阱

  • **换行：**使用两个尾随空格或 <br>。
  • **列表嵌套：**保持嵌套项缩进一致（2-4 个空格）。
  • **代码块：**在起始反引号后添加语言名称以实现语法高亮。
  • **表格：**在表格前保留一个空行。
  • **图片：**务必包含具有描述性的 alt 文本。
  • **混用制表符/空格：**优先使用空格以确保渲染效果一致。

入门模板

复制并根据需要调整：

### Title of TextChart

Short intro paragraph that explains the context.

Value of the metric ${metric} is measured.

![image](https://processmind.com/logo.webp)

Visit us at: https://processmind.com

####  Key Points
- Point A
- Point B
- Point C