Appendix G · Markdown Primer

附录 G Markdown 入门

PVE 备注 / 描述字段(资源池备注、备份 notes、节点 / VM / 容器 description 等)支持 Markdown 渲染 , 让纯文本说明也能富文本展示。

G.Markdown 入门Markdown Primer

基本语法

标题
用 1 – 6 个 # 开头 :# 一级标题、 ## 二级……
段落
空行分隔即可 —— 不需要特殊标记。行尾两个空格表示软换行。
强调
*斜体* 或 _斜体_ ; **粗体** 或 __粗体__ ; ~~删除~~。
无序列表
用 - / * / + 开头 , 缩进表示嵌套。
有序列表
1. / 2. 等开头 —— 实际编号会按顺序自动渲染(写 1. 三次也合法)。
链接
[显示文字](https://url)。
图片
![替代文字](https://url/img.png)。
引用
行首 >, 可嵌套(>> 嵌套引用)。
水平线
单独一行 --- 或 ***。

代码

  • 行内代码:用单反引号 , 如 `pvesm status`。
  • 代码块:用三反引号 , 可选语言提示:
```bash
pveum user add admin@pam --comment "管理员"
```

另一种写法 :每行缩进 4 个空格也成代码块。

表格

| 字段 | 类型 | 说明 |
|------|------|------|
| name | string | 名称 |
| size | int | 大小 (GB) |

表头分隔行的 :--- / ---: / :---: 控制对齐(左 / 右 / 居中)。

完整示例

# Web 服务器组

负责 **公司主站** 与 _staging_ 环境。

- web01 — 主节点
- web02 — 备节点

部署步骤 :

1. 拉镜像 `docker pull nginx:stable`
2. 启动容器
3. 检查 `/health` 端点

更多见 [运维 Wiki](https://wiki.example.com/web)。

```bash
ansible-playbook -i hosts deploy.yml
```

> 注意 :升级前先拉一份快照。
NOTE

PVE 当前的 Markdown 渲染基于通用 CommonMark 子集 , 但出于安全考量 , 不允许 内联原始 HTML 标签。链接的 URL 默认在新标签页打开。

小贴士

  • 反引号嵌套:行内代码若本身含反引号 , 用更多反引号包围 —— 例 :``含 `` 反引号的代码``。
  • 转义:对 * _ # > 等元字符前加 \ 即可转义为字面字符。
  • 列表与代码块共存:列表项内的代码块需缩进一个 tab 或 4 个空格才能正确归属于该列表项。
  • 硬换行:段内换行用行尾两空格 , 段间换行用空行。