Skip to content

Markdown 语法简介 ​

Markdown 用简单的标记表达标题、列表、强调等结构,适合写作和交换文档。本文介绍常用写法,示例中的符号均为半角字符。

WonderPen 支持部分 Markdown 输入快捷方式,例如在空段落输入 # 后加空格创建标题,输入 **文字** 添加粗体。可在【设置】→【高级】→【Markdown】中调整这些规则。输入时的自动转换、粘贴 Markdown和导入 Markdown 文件是不同的操作,不是下面每种语法都会在逐字输入时自动转换。具体操作见编辑器。

段落与换行 ​

在 Markdown 源文本中,用一个空行分隔两个段落。需要在同一段落内强制换行时,可在行末添加两个空格后换行;普通的单次换行如何显示,取决于读取它的应用。

md
这是第一段。

这是第二段。

在 WonderPen 的编辑器中,可直接按回车创建新段落;编辑器会维护段落结构,无需额外输入一个空行。

标题 ​

在行首输入一至六个 #,后接一个空格和标题文字:

md
# 标题 1

## 标题 2

### 标题 3

#### 标题 4

##### 标题 5

###### 标题 6

以此类推,标题最多六级。# 与标题文字之间需要一个空格。

示例:

标题 1

标题 2

标题 3

标题 4

标题 5
标题 6

列表 ​

Markdown 下,列表的显示只需要在文字前加上 - 或 * 即可变为无序列表,加上 1. 、2. 、3. 等编号则变为有序列表。列表符号或编号后需要一个空格。

无序列表:

md
- 项目 1
- 项目 2
- 项目 3
示例:
  • 项目 1
  • 项目 2
  • 项目 3

有序列表:

md
1. 项目 1
2. 项目 2
3. 项目 3
示例:
  1. 项目 1
  2. 项目 2
  3. 项目 3

引用 ​

在引用段落的开头加上 >。引用多段内容时,在段落之间保留只有 > 的空行:

md
> 这是第一段引用。
>
> 这是第二段引用。

这是第一段引用。

这是第二段引用。

超链接 ​

要在文档中插入超链接,可以使用以下语法:

md
[链接文字](链接地址)
示例:

[WonderPen](https://www.tominlab.com/wonderpen) 会被渲染为:WonderPen。

图片 ​

插入图片的语法与插入链接的语法类似,区别在于前面多了一个感叹号 !。

md
![图片说明](images/example.png)

图片路径可以是网址或相对于 Markdown 文件的路径。WonderPen 中也可通过插入图片功能选择本地文件,不必手写路径。

粗体与斜体 ​

用两个 * 包含的文本会渲染为粗体,一个 * 包含的文本渲染为斜体。如下:

md
**粗体**

*斜体*
示例:

**粗体** → 粗体

*斜体* → 斜体

代码 ​

行内代码用一对反引号包围,例如 `print("Hello")`,渲染为 print("Hello")。

多行代码放在三反引号围栏中,开始和结束的围栏各占一行:

md
```python
print("Hello")
print("WonderPen")
```

启用相应输入规则后,在 WonderPen 的空段落(不在列表或引用中)输入连续三个反引号时,可直接创建代码块;围栏后的语言名称属于 Markdown 源文件写法,不代表输入时还需照抄完整围栏。

删除线与转义 ​

~~不再使用的文字~~ 显示为 不再使用的文字。这是常见扩展语法,不是所有 Markdown 工具都支持。

要显示标记本身,可在符号前加反斜杠,例如 \*文字\* 显示为 *文字*,而不是斜体。代码块和行内代码也适合展示原始语法。

表格 ​

表格属于常见扩展语法,表格分为表头、对齐设置、表内容三个部分。比如下面的例子:

|左对齐|居中对齐|右对齐|
|---|:---:|---:|
|AAA|abc|10|
|BBB|33|5|

会被渲染成如下的表格:

左对齐居中对齐右对齐
AAAabc10
BBB335

分割线 ​

如果想在页面插入分割线,可以单独一行输入三个 * 或 -。在源文件中建议前后各留一个空行,以免 --- 被识别为前一行的标题下划线。如下:

md
***

或

md
---
示例:

*** 会被渲染为:


--- 会被渲染为:


在 WonderPen 中使用 ​

表格、链接和图片也可以通过编辑器的插入功能创建。需要保留输入的星号等原始标记时,可使用转义、代码格式,或关闭相应 Markdown 自动转换规则。导出为 Markdown 后,在其他应用中打开时,外观可能不同,但标题、列表等语义结构可以保留。