Asciidoctor 工具

由于 AsciiDoc 语法只是纯文本,您可以使用任何文本编辑器来编写 AsciiDoc 文档。您不需要像 Microsoft Word 或 Google Docs 这样的复杂文字处理程序。事实上,您不应该使用这些程序,因为它们会在文档中添加您看不到但会使转换过程变得繁琐的垃圾信息。

以下是预览和编辑 AsciiDoc 文档的不同方法的概述。

托管的 Git 存储库

许多流行的 Git 存储库托管服务,包括 GitHubGitLabCodeberg,都支持编辑和预览 AsciiDoc 文件。为了激活此支持,文件必须具有受支持的 AsciiDoc 扩展名,例如 .adoc

当您在这些网站上查看 AsciiDoc 文件时,您将看到 AsciiDoc 内容的 HTML 预览。此预览由 Asciidoctor 提供支持。渲染的 HTML 是由内置 HTML 转换器生成的嵌入式输出。这意味着它看起来不会像 Asciidoctor 生成的独立 HTML 文档。相反,HTML 会经过样式设置以匹配托管服务的 theme,并经过清理,因此不会影响页面的渲染。这意味着某些功能可能不可用。

GitHub 和 GitLab 会对源代码块应用语法高亮。这两个服务还会在节标题旁边添加浮动的锚点链接。您可以通过在 URL 末尾添加片段标识符来深度链接到特定节或另一个锚点。

GitLab 上的 AsciiDoc 预览目前支持比 GitHub 更多的 AsciiDoc 功能。在 GitLab 上,您可以找到对 include 指令、admonition 图标、图表和 STEM 表达式的支持。另一方面,GitHub 提供了一个目录浏览器,而在 GitLab 上您必须使用 toc 属性显式添加 TOC。

在 GitHub 上,如果您想查看 AsciiDoc 文件的源代码而不是预览,请点击 Code 按钮,或在 URL 末尾追加 ?plain=1

如果您通过点击 GitHub 或 GitLab 上的 Edit file 按钮进入编辑模式,您可以修改 AsciiDoc 文件的源代码,并在提交更改之前预览修改后的源代码。GitLab 甚至允许您使用其 Web IDE 在一次提交中编辑多个文件。

Web 浏览器插件(仅预览)

要在 Web 浏览器中预览 AsciiDoc 文档,请安装 Chrome 扩展Edge 插件Firefox 插件Opera 插件(均来自同一代码库)。然后,您只需访问 AsciiDoc 文件即可看到其渲染为 HTML 的效果。

IDE 和文本编辑器

以下 IDE 和文本编辑器支持 AsciiDoc 语法,并且大多数都提供使用 Asciidoctor 进行文档预览渲染。

AsciiDocFX

AsciiDoc FX 是一个使用 JavaFX 8 编写的编辑器和终端模拟器。有关下载和安装说明,请参阅其文档。

Atom

Atom 编辑器的官方网站已宣布 Atom 将于 2022 年底停用。

请参阅 Sunsetting Atom

安装 Atom。然后从 Atom 编辑器菜单中,导航到 Atom  Preferences。从那里,打开 Packages 选项卡并安装

AsciiDoc Preview

启用实时预览

AsciiDoc Language

启用语法高亮(AsciiDoc 语言支持)

AsciiDoc Image Helper

提供从剪贴板粘贴图像的功能

AsciiDoc Autocomplete

自动完成 AsciiDoc 语言项

AsciiDoc Assistant

为 Atom 安装用于编辑 AsciiDoc 文件的有用组件(包括上述包)

Brackets

安装 Brackets。然后从 Brackets 文件菜单中,打开扩展管理器。浏览可用扩展并安装 AsciiDoc Preview

更多信息

Eclipse

Eclipse Marketplace 安装开源插件 Asciidoctor Editor,或访问 项目仓库

IntelliJ IDEA

社区 AsciiDoc 插件增加了在 IDE 中编辑 AsciiDoc 文件支持,包括语法高亮、自动完成和实时预览。它支持 Antora 和 Spring REST Docs,并使用 Asciidoctor PDF 创建 PDF。

它适用于免费的社区版以及 IntelliJ IDEA、CLion、PhpStorm、RubyMine、Android Studio 等的付费版。

SciTE

安装 SciTE 5.2.3 或更高版本。要启用 AsciiDoc lexer,请按照以下步骤操作:

  1. 编辑用户属性文件,并从 imports.exclude 中的列表中移除 asciidoc

  2. 重启 SciTE。

  3. SciTE 将自动对以 .adoc.asciidoc 结尾的文件应用 AsciiDoc 语法高亮。

SciTE 不提供像本页面上列出的其他编辑器那样的文档预览渲染。

Visual Studio Code

Visual Studio Code 为 AsciiDoc 提供丰富的语言支持,并在您键入时提供实时预览。

  1. 安装 Visual Studio Code

  2. 启动 Visual Studio Code,然后按 Ctrl+P 打开 Quick Open 对话框。

  3. 键入以下命令来查找并安装 AsciiDoc 扩展(由 João Pinto 开发)

    ext install asciidoctor.asciidoctor-vscode

更多信息