文档列表
本页内容

Markdown Notation

Markdown Notation Manual (Quick Reference & Examples)

Use this guide to format content in your Text Chart. It follows CommonMark basics with popular GitHub-Flavored Markdown (GFM) extensions like tables, task lists, and strikethrough.


标题

####### 表示不同级别标题:

# H1
##  H2
###  H3
####  四级标题
#####  五级标题
######  六级标题

段落与换行

段落请用空行分隔。

软换行:行尾输入两个空格<br>

第一行以软换行结束··
续写下一行。

空行后新段落。

强调(斜体、粗体、删除线)

*斜体*_斜体_
**粗体**__粗体__
***粗斜体***
~~删除线~~   <!-- GFM -->

列表(无序、有序、嵌套)

无序列表:用 -+*。有序:1. 2. 依次类推。

- 条目A
- 条目B
  - 嵌套B1
  - 嵌套B2

1. 步骤一
2. 步骤二
   1. 子步骤
   2. 子步骤

提示: 嵌套项建议统一缩进2-4空格。


链接

可用内联或引用形式:

内联:[ProcessMind](https://processmind.com)
带标题:[Site](https://example.com "可选标题")

引用式:[Docs][docs-link]

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

图片

Alt 文本有助于无障碍和 SEO。

![简单描述图片](https://example.com/image.png "可选标题")

引用式图片:

![Logo][logo]

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

引用块(Blockquotes)

每行开头用 >。多层嵌套用多个 >

> 单行引用。
>
> 多段落引用:
>
> > 第二层嵌套引用。

代码(内联 & 块)

内联代码用三个反引号 ```code。[你的代码] ```

代码块用三个反引号包裹,可加语言高亮。

  • 例如 ```code
这是 `inline code`(内联代码)。

如内容本身含三个反引号,代码块用四个反引号包裹。


分隔线

一行写三个或更多 ---***___ 可生成分隔线:

---

表格

| 竖线分隔,标题横线用 ---,冒号 (:) 表示对齐方式。

| 列名          | 类型    | 说明           |
|:--------------|:-------:| :--------------|
| Name          | String  | 左对齐         |
| Score         | Number  | 左对齐         |
| Description   | String  | 左对齐         |

列名类型说明
NameString左对齐
ScoreNumber左对齐
DescriptionString左对齐

表格前建议留空行,利于正确解析。


任务列表

- [ ]- [x]

- [x] 设计 schema
- [ ] 实现 API
- [ ] 编写测试
  • 设计 schema
  • 实现 API
  • 编写测试

转义特殊字符

用反斜杠 \ 转义,输出原字符。

\*不是斜体\*,显示星号本身。
用反斜杠可转义 \#, \[, \], \(, \), \_, \*, \`, \|, \>

引用式链接及图片

引用统一集中文档底部,更清晰。

阅读 [指南][g]
查看 ![徽章][b]

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

自动链接 & 邮件

纯 URL 自动转为链接。用尖括号可强制转为链接。

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

内联 HTML(可选)

多数渲染器支持安全的内联 HTML,Markdown 不足时用。

<strong>粗体</strong> 和 <em>斜体</em> 可用 HTML 标签。
<br>
<span style="font-variant:small-caps">小型大写</span>

注意:因安全与兼容性,并非所有标签都支持。


常见问题

  • 换行: 行尾加两个空格或用 <br>
  • 列表嵌套: 嵌套项统一缩进 (2–4 空格)。
  • 代码块: 反引号后可加语言高亮。
  • 表格: 表格前加空行利于解析。
  • 图片: alt 文本要简明介绍图片。
  • 空格/Tab 混用: 推荐用空格,渲染更一致。

起步模板

复制并根据需要调整:

### 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

####  重点
- 要点A
- 要点B
- 要点C