04 列表

列表是文档里出现频率最高的结构：步骤、要点、清单、层级说明都靠它。

无序列表

用 -、*、+ 开头（三选一，同一份文档建议统一用 -）：

- 苹果
- 香蕉
- 橙子

• 苹果
• 香蕉
• 橙子

规则：符号后面必须有一个空格。-苹果 ❌ 不会变成列表。

有序列表

用数字加点开头：

1. 打开服务器目录
2. 修改配置文件
3. 重启服务

1. 打开服务器目录
2. 修改配置文件
3. 重启服务

懒人技巧：所有序号都写 1.，渲染时会自动编号：

1. 第一步
1. 第二步
1. 第三步

渲染结果照样是 1、2、3。这样插入/删除条目时不用重新编号。

嵌套列表（子列表）

关键：子项要缩进 2~4 个空格（推荐 2 空格，或用 Tab）：

- 服务端
  - 配置文件
  - 日志目录
- 客户端
  - 模组文件
  - 存档

• 服务端
• 配置文件
• 日志目录
• 客户端
• 模组文件
• 存档

嵌套更深就继续缩进：

- 一级
  - 二级
    - 三级

⚠️ 缩进不足（比如只缩 1 个空格）在部分解析器里会失效，统一缩 2 个空格最稳。

有序 + 无序混合

1. 准备环境
   - 安装 Java 17
   - 安装 Gradle
2. 创建项目
   - 用 IDEA 向导
   - 或手动建目录

1. 准备环境
2. 安装 Java 17
3. 安装 Gradle
4. 创建项目
5. 用 IDEA 向导
6. 或手动建目录

列表里的多段内容

列表项里要写多段或代码时，后续内容要缩进对齐：

- 第一项，后面跟一段说明。

  这是属于第一项的第二段（缩进 2 空格）。

- 第二项

列表里放代码块：

- 修改配置：

  ```yaml
  server-port: 25565
  ```

- 重启服务

列表里放引用、图片等

内容	写法要点
引用	子行写 > 引用内容，缩进对齐
图片	子行写 ，缩进对齐
复选框	见 07 表格与任务列表

常见坑

现象	原因	解决
列表没生效，还是普通文字	符号后面没空格	- 苹果
子列表变成同级	缩进不够	缩 2 个空格
中文全角破折号「－」或「、」	用了错误的符号	用半角 -
列表被打断成两段	中间混了空行又没缩进	空行后继续时保持缩进
有序列表从 1 重新开始	新列表前必须有空行	与上一列表之间空一行

什么时候该用列表

• 步骤：有序列表
• 并列要点：无序列表
• 待办 / 检查项：任务列表（下一部分）
• 纯段落文字：别强行拆成列表，读起来反而碎

💡 写文档的经验：超过 5 条的列表要考虑分组，用二级标题分开比一长串列表更好读。

本章练习

1. 写一个三步的操作步骤（有序列表）。
2. 写一个「服务端 / 客户端」两级结构（嵌套无序列表）。
3. 写一个「1. 准备」下面套两条 - 的混合列表。

下一章：链接与图片。