外观
Markdown 常用指令
Markdown 是一种轻量级标记语言,通过简单的符号语法实现结构化文本编写,让纯文本文档具有清晰的格式与语义表达能力,广泛应用于技术文档、博客写作和协作平台。VitePress 站点本身也是用 Markdown 编写,本文整理常用指令,方便日常写作速查。
标题系统
Markdown 支持六级标题,使用井号 # 表示层级:
- 一级标题:
# 标题内容 - 二级标题:
## 标题内容 - 三级标题:
### 标题内容 - 四级标题:
#### 标题内容 - 五级标题:
##### 标题内容 - 六级标题:
###### 标题内容
最佳实践:一级标题通常用于文档主标题,井号与标题内容之间需添加空格;保持层级逻辑清晰,建议不要跳过标题层级。
文本格式化
| 效果 | 语法 |
|---|---|
| 粗体 | **粗体** 或 __粗体__ |
| 斜体 | *斜体* 或 _斜体_ |
| 粗斜体 | ***粗斜体*** 或 ___粗斜体___ |
~~删除线~~ | |
| ==高亮== | ==高亮文本==(部分平台支持) |
列表系统
无序列表:使用 -、* 或 + 开头,后跟空格:
markdown
- 项目一
* 项目二
+ 项目三有序列表:使用数字和句点开头,后跟空格:
markdown
1. 第一项
2. 第二项
3. 第三项任务列表(GitHub 风格):
markdown
- [x] 已完成任务
- [ ] 未完成任务嵌套列表:通过缩进 4 个空格或 1 个 Tab 实现层级嵌套。
链接与图片
- 链接:
[链接文本](URL "可选标题") - 引用式链接(长文档推荐,便于统一维护):
markdown
这是第一个链接 [CSDN],这是第二个链接 [GitHub]
[SSSI]: https://www.sssi.cn
[GitHub]: https://github.com- 图片:
 - 图片 + 链接组合:
[](链接URL)
代码块
行内代码:使用反引号包裹,如 `print("Hello")`。
多行代码块:使用三个反引号包裹,可指定语言以启用语法高亮:
markdown
```python
def fibonacci(n):
"""生成斐波那契数列"""
a, b = 0, 1
result = []
while len(result) < n:
result.append(a)
a, b = b, a + b
return result
print(fibonacci(10))
```支持 Python、JavaScript、Java、C++、HTML、CSS、SQL 等多种语言。
引用
- 单行引用:在内容前加
>,如> 这是单行引用文本。 - 多行引用:每行开头加
>:
markdown
> 这是多行引用文本。
> 第二行引用内容。- 嵌套引用:使用
>>表示更深层次的引用。
表格
基础表格:
markdown
| 列1 | 列2 | 列3 |
| --- | --- | --- |
| 数据1 | 数据2 | 数据3 |对齐方式:
- 左对齐:
|:---| - 右对齐:
|---:| - 居中:
|:---:|
分隔线
使用三个或更多短横线、星号或下划线:
markdown
---
***
___脚注
- 添加脚注:
这是一个具有注脚的文本。[^1] - 定义脚注:
[^1]: 注脚的解释
转义字符
使用反斜杠 \ 转义特殊字符,让它们以原样显示:
\*显示星号而非斜体\#显示井号而非标题\(显示左括号而非链接
高级功能与扩展
数学公式
使用 LaTeX 语法(VitePress 可通过 markdown-it 数学插件启用 KaTeX 渲染):
text
Gamma 公式展示 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$
$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$可视化图表(Mermaid)
markdown
```mermaid
graph LR
A[长方形] -- 链接 --> B((圆))
A --> C(圆角长方形)
B --> D{菱形}
C --> D
```甘特图、时序图、类图等也支持。
自动链接
直接输入 URL(如 https://www.sssi.cn)会自动转换为可点击链接。
实用技巧与规范
语法规范建议
- 标题层级:建议最多使用到四级标题,保持文档结构清晰
- 空格使用:井号与标题内容间需添加空格,列表标记后需添加空格
- 段落分隔:使用空行分隔段落,避免冗余换行符
工程化最佳实践
- 文档结构:使用标题系统构建清晰的文档大纲,便于自动生成目录
- 代码块规范:始终指定代码语言,确保语法高亮正确
- 图片管理:使用相对路径管理图片资源,如
./assets/目录
Markdown 的核心价值在于「以内容为中心」的写作理念,通过极简的符号系统实现结构化表达,让作者专注于内容本身而非格式调整。掌握这些指令后,你就能高效创建结构清晰、语义明确的技术文档、博客文章和项目说明。
