目录(TOC)是AsciiDoc文档中各节标题的索引。当启用TOC时,AsciiDoc处理器会自动从文档的结构生成TOC,并将其插入到输出文档中。目录的层级数(即,深度)是可配置的。

激活目录

要启用自动生成的目录(TOC),请设置文档的 toc 属性。在文档头部的属性条目中激活 toc 属性。

使用toc属性启用目录
Unresolved directive in index.adoc - include::example$toc.adoc[tag=header]
:toc: (1)
Unresolved directive in index.adoc - include::example$toc.adoc[tag=body]
  1. 在头部使用属性条目设置`toc`属性。当`toc`的值为空时,处理器将使用属性的默认值。

默认情况下,目录直接渲染在文档头部之下,标题为_Table of Contents_,并且仅包含1级和2级标题。使用toc属性启用目录的结果如下所示。

默认目录

您可以自定义 目录的标题节级别的深度,以及 目录在文档中的位置。但是,并不是所有的属性都被所有的转换器支持。有关每个转换器可用的属性,请参见 toc-ref.html

从命令行界面激活TOC

toc` 属性也可以通过命令行(-a toc)来指定。

通过命令行界面启用TOC
$ asciidoctor -a toc my-document.adoc