SUMMARY.md

mdBook使用摘要文件来了解要包含哪些章节、它们应该以什么顺序出现、它们的层次结构是什么以及源文件在哪里。 没有这个文件，就没有书。 这个markdown文件必须命名为SUMMARY.md。 它的格式非常严格，必须遵循下面概述的结构，以便于解析。 下面未指定的任何元素，无论是格式还是文本，最多可能会被忽略，或者在尝试构建书籍时可能会导致错误。

结构

1. 标题 - 然是可选的，但通常以标题开头，通常是# Summary. 然而，这被解析器忽略，并且可以省略。

   # Summary
   

2. 章节前缀 - 在主要编号章节之前，可以添加不编号的前缀章节。 这对于前言、介绍等很有用。但是，有一些限制。 章节前缀不能嵌套； 它们都应该在根级别。 一旦添加了编号的章节，就无法添加章节前缀。

   [A Prefix Chapter](relative/path/to/markdown.md)
   
   - [First Chapter](relative/path/to/markdown2.md)
   

3. 部分标题 - 标题可用作以下编号章节的标题。 这可用于在逻辑上分隔本书的不同部分。 标题呈现为不可点击的文本。 标题是可选的，编号的章节可以根据需要分成任意多个部分。

   # My Part Title
   
   - [First Chapter](relative/path/to/markdown.md)
   

4. 章节编号 - 章节编号概述了本书的主要内容，并且可以嵌套，从而形成一个很好的层次结构（如章节、子章节等）

   # Title of Part
   
   - [First Chapter](relative/path/to/markdown.md)
   - [Second Chapter](relative/path/to/markdown2.md)
      - [Sub Chapter](relative/path/to/markdown3.md)
   
   # Title of Another Part
   
   - [Another Chapter](relative/path/to/markdown4.md)
   

   章节编号可以用-或*表示（不要混合分隔符）。

5. 章节后缀 - 与章节前缀一样，章节后缀是无编号的，但它们位于已编号的章节之后。

   - [Last Chapter](relative/path/to/markdown.md)
   
   [Title of Suffix Chapter](relative/path/to/markdown2.md)
   

6. 章节草稿 - 章节草稿是没有文件和内容的章节。 一章草稿的目的是表明未来仍有待编写的章节。 或者当您仍在对书的结构进行布局以避免创建文件时，你仍在大量更改书的结构。 章节草稿将在HTML 呈现器中呈现为目录中的禁用链接，您可以在左侧目录中的下一章节中看到。 章节草稿像普通章节一样编写，但不写入文件路径。

   - [Draft Chapter]()
   

7. 分隔符 - 可以在任何其他元素之前、之间和之后添加分隔符。 它们会在构建的目录中生成 HTML 渲染行。 分隔符是仅包含破折号和至少三个破折号的行: ---.

   # My Part Title
   
   [A Prefix Chapter](relative/path/to/markdown.md)
   
   ---
   
   - [First Chapter](relative/path/to/markdown2.md)
   

样例

下面是本指南的SUMMARY.md的markdown文件源，结果目录呈现在左侧。

# Summar

[简介](README.md)

# 用户指南
---

- [安装](guide/installation.md)
- [阅读说明](guide/reading.md)
- [创建](guide/creating.md)

# 参考指南
---

- [命令行](cli/README.md)
  - [init](cli/init.md)
  - [build](cli/build.md)
  - [watch](cli/watch.md)
  - [serve](cli/serve.md)
  - [test](cli/test.md)
  - [clean](cli/clean.md)
- [格式](format/README.md)
  - [SUMMARY.md](format/summary.md)
  - [配置](format/configuration/README.md)
    - [常规配置](format/configuration/general.md)
    - [预处理器](format/configuration/preprocessors.md)
    - [渲染](format/configuration/renderers.md)
    - [环境变量](format/configuration/environment-variables.md)
  - [主题](format/theme/README.md)
    - [index.hbs](format/theme/index-hbs.md)
    - [语法高亮](format/theme/syntax-highlighting.md)
    - [编辑器](format/theme/editor.md)
  - [数学公式](format/mathjax.md)
  - [mdBook特性](format/mdbook.md)
  - [Markdown语法](format/markdown.md)
- [持续集成](continuous-integration.md)
- [开发人员特性](for_developers/README.md)
  - [预处理器](for_developers/preprocessors.md)
  - [后端替代](for_developers/backends.md)
- [贡献列表](misc/contributors.md)