文件和行号信息

当激活时,sourcemap键会为Antora的日志记录器和Asciidoctor扩展提供有关AsciiDoc块的额外文件和行号信息。

什么是sourcemap?

sourcemap是AsciiDoc处理器的一个功能,用于跟踪和存储每个解析的AsciiDoc块的文件和行号。一些Asciidoctor扩展依赖于此信息才能成功运行或返回正确的输出。Antora的日志记录器使用此信息将有关AsciiDoc语法的错误、警告和信息消息的行号和包含指令源文件位置上下文添加到其记录中。例如,当AsciiDoc处理器的sourcemap被打开(激活)时,Antora的日志记录器可以提供未解析的交叉引用位于文件中的行号。如果关闭sourcemap,则记录器只能提供包含损坏交叉引用的页面文件的位置。

通过在playbook中激活sourcemap键或使用--asciidoc-sourcemap选项来打开sourcemap功能。

默认sourcemap值

sourcemap键默认设置为false。也就是说,在运行时未激活(关闭),除非在playbook中或使用--asciidoc-sourcemap选项从CLI中激活。

为什么默认情况下不打开sourcemap?

Antora默认不激活sourcemap键,因为它会向构建过程添加额外的处理和对象分配。这可能会增加生成站点所需的时间。

sourcemap键

可选的sourcemap键映射到asciidoc键

示例1. antora-playbook.yml
asciidoc:
  sourcemap: true

要激活sourcemap键,在playbook文件中将其赋值为true

AsciiDoc sourcemap选项

您无需直接修改playbook文件即可激活或停用此键。要从CLI激活sourcemap,请使用--asciidoc-sourcemap选项

$ antora --asciidoc-sourcemap antora-playbook.yml

--asciidoc-sourcemap选项会覆盖playbook文件中分配给sourcemap键的值。

当在playbook文件中激活sourcemap键时,无法从命令行停用它。CLI只能激活它。