Gordon.Guo全栈编程-开发文档

Appearance

Markdown 列表 ​

Markdown 支持有序列表和无序列表。

无序列表 ​

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记，这些标记后面要添加一个空格，然后再填写内容：

markdown
* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项


- 第一项
- 第二项
- 第三项

显示结果：

  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项

选择建议： ​

  • 建议统一使用减号 -，因为它在视觉上更清晰
  • 在同一文档中保持一致的标记方式
  • 标记符号后必须有一个空格

有序列表 ​

有序列表用于展示有顺序要求的步骤或项目。

有序列表使用数字并加上 . 号来表示，如：

markdown
1. 第一项
2. 第二项
3. 第三项

显示结果：

  1. 第一项
  2. 第二项
  3. 第三项

数字可以不连续 ​

Markdown 会自动修正数字顺序：

markdown
1. 第一项
3. 第二项（实际显示为2）
7. 第三项（实际显示为3）

显示结果：

  1. 第一项
  2. 第二项（实际显示为2）
  3. 第三项（实际显示为3）

从指定数字开始： ​

markdown
5. 第五项
6. 第六项
7. 第七项

显示结果：

  1. 第五项
  2. 第六项
  3. 第七项

列表嵌套 ​

列表嵌套技巧 ​

列表可以嵌套使用，创建多层次的结构：

无序列表嵌套： ​

markdown
- 水果
  - 苹果
    - 红苹果
    - 绿苹果
  - 香蕉
  - 橙子
- 蔬菜
  - 胡萝卜
  - 白菜

显示结果：

  • 水果
    • 苹果
      • 红苹果
      • 绿苹果
    • 香蕉
    • 橙子
  • 蔬菜
    • 胡萝卜
    • 白菜

有序列表嵌套： ​

markdown
1. 准备阶段
   1. 收集资料
   2. 制定计划
2. 执行阶段
   1. 开始实施
   2. 监控进度
3. 总结阶段

显示结果：

  1. 准备阶段
    1. 收集资料
    2. 制定计划
  2. 执行阶段
    1. 开始实施
    2. 监控进度
  3. 总结阶段

混合嵌套： ​

markdown
1. 主要任务
   - 子任务A
   - 子任务B
     1. 详细步骤1
     2. 详细步骤2
   - 子任务C
2. 次要任务

显示结果：

  1. 主要任务
    • 子任务A
    • 子任务B
      1. 详细步骤1
      2. 详细步骤2
    • 子任务C
  2. 次要任务

列表混合嵌套只需在子列表中的选项前面添加两个或四个空格即可：

markdown
1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

显示结果：

  1. 第一项：
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项：
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

任务列表（复选框列表） ​

任务列表是 GitHub 风格 Markdown 的扩展功能，现在被广泛支持：

基本语法： ​

markdown
- [ ] 未完成的任务
- [x] 已完成的任务
- [ ] 另一个未完成的任务

显示结果：

  • [ ] 未完成的任务
  • [x] 已完成的任务
  • [ ] 另一个未完成的任务

实际应用示例： ​

markdown
## 项目待办清单

### 设计阶段
- [x] 需求分析
- [x] 原型设计
- [ ] UI 设计

### 开发阶段
- [ ] 前端开发
  - [x] 页面布局
  - [ ] 交互功能
  - [ ] 响应式适配
- [ ] 后端开发
  - [ ] 数据库设计
  - [ ] API 开发
  - [ ] 性能优化

### 测试阶段
- [ ] 单元测试
- [ ] 集成测试
- [ ] 用户验收测试

显示结果：

项目待办清单 ​

设计阶段 ​

  • [x] 需求分析
  • [x] 原型设计
  • [ ] UI 设计

开发阶段 ​

  • [ ] 前端开发
    • [x] 页面布局
    • [ ] 交互功能
    • [ ] 响应式适配
  • [ ] 后端开发
    • [ ] 数据库设计
    • [ ] API 开发
    • [ ] 性能优化

测试阶段 ​

  • [ ] 单元测试
  • [ ] 集成测试
  • [ ] 用户验收测试

使用技巧： ​

  • 方括号内的空格和 x 很重要：[ ] 和 [x]
  • 可以与嵌套列表结合使用
  • 在项目管理、学习计划、生活清单中特别有用
  • 某些编辑器支持点击复选框来切换状态

高级列表技巧： ​

列表项中包含多段内容：

markdown
1. 第一项

   这是第一项的详细说明，需要与列表项对齐缩进。
   
   还可以包含第二段内容。

2. 第二项

   > 可以在列表项中使用引用

显示结果：

  1. 第一项

    这是第一项的详细说明，需要与列表项对齐缩进。

    还可以包含第二段内容。

  2. 第二项

    可以在列表项中使用引用

列表项中的换行：

markdown
- 这是一个很长的列表项，
  需要换行显示，注意第二行需要与第一行对齐
- 另一个列表项

显示结果：

  • 这是一个很长的列表项， 需要换行显示，注意第二行需要与第一行对齐
  • 另一个列表项

通过掌握这些基础语法，你已经能够创建结构清晰、格式规范的 Markdown 文档了。这些语法是日常写作中最常用的，熟练掌握它们将大大提高你的文档编写效率。

Copyright © 2025 Gordon.Guo