通过 CLI 处理 AsciiDoc

当 Asciidoctor gem 成功安装后,名为 asciidoctor 的 Asciidoctor 命令行界面 (CLI) 将会出现在你的 PATH 中。

版本和运行时

要确认 CLI 是否可用,请在你的终端应用程序中执行以下命令:

$ asciidoctor --version

或者,你可以将 --version CLI 选项缩短为 -v

$ asciidoctor -v

如果此命令成功完成,Asciidoctor 和运行时环境的信息将打印到你的终端的标准输出。

Asciidoctor 2.0.26 [https://asciidoctor.org.cn]
Runtime Environment (ruby 3.3.0 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:UTF-8 ex:UTF-8)

运行时环境信息会根据你使用的 Ruby 版本以及操作系统的编码设置而有所不同。

转换 AsciiDoc 文件

要从 CLI 调用 Asciidoctor 并转换一个 .adoc 文件,请执行:

$ asciidoctor <asciidoc-file>

这将使用内置的默认选项,并在与输入文件相同的目录中创建一个新文件,该文件具有相同的基本名称,但扩展名为 .html

Asciidoctor CLI 接受许多选项来控制处理器的行为,从设置附加属性 (-a) 到指定输出文件的写入位置 (-o)。大多数选项都有长格式 (例如 --out-file) 和短格式 (例如 -o)。本文档中全程使用短格式。一旦你熟悉了这些选项,短格式是首选且最常见的,因为它需要的键入量大大减少。

CLI 选项 描述了 Asciidoctor CLI 的可用选项和参数。

帮助主题

--help 选项提供了 asciidoctor 命令的自描述文档,按主题分组。如果你不指定主题,--help 选项将打印 asciidoctor 命令的用法说明。

$ asciidoctor --help

或者,你可以将 --help CLI 选项缩短为 -h

$ asciidoctor -h

你可以通过将 manpage 主题传递给 --help 选项来生成 asciidoctor 命令的完整文档 (即 man page)。你可以将该输出通过管道传递给 man 分页器来查看它。

$ asciidoctor --help manpage | man -l -

你也可以在这个文档中找到以 HTML 渲染的 asciidoctor 命令的 man page,你可以在浏览器中查看。请参阅 asciidoctor(1)

你可以通过将 syntax 主题传递给 --help 选项来打印 AsciiDoc 语法备忘单。

$ asciidoctor --help syntax

备忘单本身是用 AsciiDoc 编写的。你可以通过将输出通过管道重新输入到 asciidoctor 命令来将其转换为 HTML。

$ asciidoctor --help syntax | asciidoctor -o syntax.html -

在浏览器中导航到 syntax.html 文件,以查看备忘单中的示例转换为 HTML 后的样子。