编写一组文档

本任务完成「从零写作一章文档并看到正确侧栏」的完整流程。

前置条件:已有源目录并可本地预览(站内搜索 ?第一个文档站)。

操作步骤

  1. 在语言目录下创建章节目录与页面(kebab-case 命名):

    mkdir -p my-docs/cn/guides
    
  2. 给章节写目录页 my-docs/cn/guides/index.md:一段概述 + 宏。

  3. 写各任务页,每页以一级标题开头:

    # 导出报表
    
    ## 前置条件
    
    ## 操作步骤
    
  4. 需要固定侧栏顺序时,在章节目录放 metadata.docdoc.json(对象形态,order 里不列 index.md):

    { "order": ["export-report.md", "import-data.md"] }
    
  5. 启动或复用预览进程查看效果:侧栏章节顺序、目录页自动目录、页内大纲、上一页/下一页都应符合预期。

结果核对清单

  • 页面标题 = 文件第一个一级标题
  • 目录按 metadata.docdoc.json(或字母序)排列
  • 目录页只写概述与 TOC 宏,没有手工维护的链接列表

写作约定的逐项说明见站内搜索 ?组织目录。