CLI 选项
安全设置
- -B, --base-dir=DIR
-
包含文档和资源的基础目录。默认为源文件所在的目录,或者如果源文件从流中读取,则为工作目录。可以将其用作限制程序执行的方式(类似 chroot)。
- -S, --safe-mode=SAFE_MODE
-
设置 安全模式 级别:unsafe、safe、server 或 secure。禁用源文件中可能危险的宏,例如
include::[]
。如果未设置,安全模式级别默认是 unsafe,当通过此脚本调用 Asciidoctor 时。
文档设置
- -a, --attribute=ATTRIBUTE
-
定义、覆盖或删除文档属性。命令行属性优先于源文件中定义的属性。
ATTRIBUTE 通常采用键值对的格式,例如 NAME=VALUE。其他可接受的格式有 NAME(其中 VALUE 默认为空字符串)、NAME!(取消分配 NAME 属性)和 NAME=VALUE@(如果 NAME 属性已经在源文档中定义,VALUE 不会覆盖该值)。包含空格的值应使用引号括起来。
此选项可以多次指定。
- -b, --backend=BACKEND
-
后端输出文件格式:支持 html5、docbook5 和 manpage。你也可以使用别名 html(别名为 html5)或 docbook(别名为 docbook5)。默认为 html5。如果 Asciidoctor 无法找到指定的后端,它将在转换过程中失败。
- -d, --doctype=DOCTYPE
-
文档类型:article、book、manpage 或 inline。设置使用 docbook 后端时的根元素,以及使用 html 后端时的 HTML body 元素的样式类。book 文档类型允许在单个文档中使用多个级别的 0 标题。manpage 文档类型启用解析产生 manpage 所需的元数据。inline 文档类型允许单个段落的内容被格式化并返回,而不将其包裹在包含元素中。默认为 article。
文档转换
- -D, --destination-dir=DIR
-
目标输出目录。默认为源文件所在的目录,或者如果源文件从流中读取,则为工作目录。如果指定了该目录,则该目录相对于工作目录进行解析。
- -e, --embedded
-
输出可嵌入的文档,省略头部、脚部以及文档外部的内容。此选项对于生成可以插入到外部模板中的文档非常有用。
- -n, --section-numbers
-
自动编号章节标题。与 --attribute numbered 同义。
- -o, --out-file=OUT_FILE
-
将输出写入文件 OUT_FILE。默认为输入文件的基本名称,后缀为 backend 扩展名。如果输入来自标准输入,则输出文件默认为标准输出。如果指定了 OUT_FILE,文件将相对于工作目录进行解析。
- -r, --require=LIBRARY
-
在执行处理器之前使用标准 Node
require
加载指定的库。此选项可以多次指定。 - -s, --no-header-footer
-
输出可嵌入的文档,省略头部、脚部以及文档外部的内容。此选项对于生成可以插入到外部模板中的文档非常有用。
- -T, --template-dir=DIR
-
包含自定义转换器模板的目录,这些模板将覆盖内置模板中的一个或多个模板。Asciidoctor.js 支持 EJS(
.ejs
)、Handlebars(.handlebars
、.hbs
)、Nunjucks(.nunjucks
、.njk
)、Pug(.pug
)和模板字面量(.js
)。
请注意,依赖是可选的,因此需要显式安装。例如,如果要使用 Nunjucks,则需要安装 nunjucks 包:
|
此选项可以多次指定,后续目录中找到的匹配模板会覆盖先前发现的模板。
了解更多关于 模板转换器 的信息。