SUMMARY.md

mdBook使用Summary文件,来了解要书的章节,应显示的顺序,层次结构以及源文件的位置。没有这个文件,就没有书.

即使SUMMARY.md是一个markdown文件, 但格式是非常严格,以便于给mdbook解析。我们来看看你应该如何格式化你的SUMMARY.md文件.

允许的 elements

  1. Title一般来说,通常以# Summary.标题开头是常见的做法,但它不是强制性的,解析器只是忽略它.如果你也是这样想,也忽略它。

  2. 开头章节位于主编号章节前,您可以添加一些不编号的元素。这对前言,介绍等很有用.但是有一些限制。你不能嵌套开头章节,它们都应该在根级别.一旦添加了编号章节,就无法添加开头章节.

    [开头章节的标题](relative/path/to/markdown.md)
    
  3. 编号章节是本书的主要内容,它们将被编号,并可以嵌套,从而产生一个很好的层次结构(章节,子章节等)

    - [编号章节的标题](relative/path/to/markdown.md)
    

    你可以使用-*表示编号的章节.

  4. 结尾章节位于在编号章节后,您可以添加几个未编号的章节.它们与开头章节相同,但是在编号章节之后,而不是之前.

所有其他元素都不受支持,最多将被忽略或导致错误.