当Asciidoctor宝石成功安装后,命名为`asciidoctor`的Asciidoctor命令行界面(CLI)将会在您的PATH路径上可用。
版本和运行时
为了确认CLI(命令行界面)可用,请在终端应用程序中执行以下命令:
$ asciidoctor --version
如果这个命令成功完成,关于Asciidoctor和运行时环境的信息将被打印到你终端的标准输出上:
Asciidoctor {release-version} [https://asciidoctor.org] Runtime Environment ({ruby-description}) (lc:UTF-8 fs:UTF-8 in:UTF-8 ex:UTF-8)
Ruby运行时环境的信息会根据你使用的Ruby版本和操作系统的编码设置而有所不同。
转换一个AsciiDoc文件
要从命令行界面调用Asciidoctor并转换一个`.adoc`文件,请执行:
$ asciidoctor <asciidoc-file>
这将使用内置的默认选项,并在输入文件所在的同一目录中创建一个新文件,该文件具有相同的基本名称,但扩展名为`.html`。
'''CLI Options 描述了 Asciidoctor CLI 可用的选项和参数。'''
帮助主题
--help` 选项为 asciidoctor
命令提供了自描述的文档,按主题分组。如果你没有指定主题,--help
选项会打印 asciidoctor
命令的用法说明:
$ asciidoctor --help
您可以通过将 manpage
主题传递给 --help
选项来生成 asciidoctor
命令的完整文档(即手册页)。您可以将该输出传递给 man
分页器以查看它:
$ asciidoctor --help manpage | man -l -
你也可以在这份文档中找到以HTML格式渲染的`asciidoctor`命令的手册页面,你可以选择在浏览器中查看。参见asciidoctor(1)。
你可以通过将 syntax
主题传递给 --help
选项来打印一个 AsciiDoc 语法小抄。
$ asciidoctor --help syntax
答案卡本身是用AsciiDoc格式编写的。您可以通过将输出重新传递到`asciidoctor`命令中来将其转换为HTML。
$ asciidoctor --help syntax | asciidoctor -o syntax.html -
在浏览器中导航到 syntax.html 文件,以查看速查表中的示例转换为HTML后的样子。