Skip to content

Markdown 写作教程

Markdown 是一种轻量文本格式,适合写教程、文档和说明书。VitePress 文档页基本都是 Markdown 文件。

一、标题

md
# 一级标题
## 二级标题
### 三级标题

一篇教程通常只写一个一级标题。

二、列表

无序列表:

md
- 第一步
- 第二步
- 第三步

有序列表:

md
1. 打开终端
2. 输入命令
3. 检查结果

三、代码块

写命令:

md
```bash
npm run dev
```

写 JSON:

md
```json
{
  "name": "demo"
}
```

四、表格

md
| 工具 | 作用 |
| --- | --- |
| Codex | AI 编程 |
| Git | 代码版本管理 |

五、提示块

VitePress 更推荐使用这种提示块:

md
::: tip 小提示
这里写提示内容。
:::

警告可以这样写:

md
::: warning 注意
这里写风险说明。
:::

你也可能在一些平台看到这种写法:

md
> [!TIP] 小提示
> 这里写提示内容。

这种写法在 GitHub 等平台常见,但不同 Markdown 渲染器支持程度不一样。写 VitePress 教程时,优先用 ::: tip::: warning

六、链接

md
[Codex 快速开始](/codex/)

外部链接:

md
[访问 coding-play](https://coding-play.codes/)

七、图片

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

图片说明要简短,方便后续维护。路径里的图片文件必须真实存在,否则页面会显示缺图。

在 VitePress 里,如果图片放在:

text
docs/public/images/demo.png

Markdown 里就可以这样引用:

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

如果图片和当前 Markdown 文件放在一起,也可以用相对路径:

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

八、让 AI 帮你写 Markdown

可以这样问:

text
请把下面内容整理成 Markdown 教程,要求包含标题、步骤、代码块和常见问题。

基于 VitePress 构建