What is Asciidoctor

What is

Asciidoctor 是一种 快速 的文本处理器和出版工具链，可以非常方便地将 AsciiDoc 转化成 HTML5、DocBook 5 或者 4.5、EPUB3、PDF 以及其他格式。 Asciidoctor 是 AsciiDoc 语法的一种主要实现。AsciiDoc 最早是由基于 Python 的 AsciiDoc 项目引入以及实现的。

Asciidoctor 是使用 Ruby 编写的，可以在任何 Ruby 运行时上使用，包括 JRuby。 它也可以通过 AsciidoctorJ 运行在 Java 虚拟机上，正式的 Java API 是由下面的 JRuby 来完成的，也可以有通过 Asciidoctor.js 在 JavaScript 中使用，Asciidoctor.js 是基于 Ruby 代码的转换编译出来的。

Asciidoctor 是使用 MIT 协议发布的开源项目。Asciidoctor gem 发布到了 rubygems.org，可以被安装到数个流行的 Linux 发行版上。该项目的 Git 库被托管在 Asciidoctor organization on GitHub，以求获得最大的参与。

当 Asciidoctor 旨在提供完全符合由 AsciiDoc Python 实现的 AsciiDoc 语法，它不仅仅是一个 AsciiDoc Python 版的克隆。

Syntax

• AsciiDoc 语法快速参考
• Asciidoctor User Manual

Asciidoctor Diagram

• Asciidoctor Diagram

Install

使用 JRuby 可以让 Asciidoctor 运行在 Java 虚拟机上。 使用 AsciidoctorJ 就可以让 Java 或者其他 Java 虚拟机语言直接调用 Asciidoctor API。 基于 AsciidoctorJ 有好多好多插件可用，这些插件可以将 Asciidoctor 整合到 Apache Maven，Gradle 或 Javadoc 构建中。

Asciidoctor 也可以运行在 JavaScript 上。 我们可以使用 Opal 将 Ruby 源码编译成 JavaScript 并生成 Asciidoctor.js，这是一个全功能版的 Asciidoctor，可以运行在任意的 JavaScript 环境中，比如 Web 浏览器 或 Node.js。 Asciidoctor.js 被用于 AsciiDoc 预览，支持 Chrome 扩展，Atom，Brackets 或其他基于 Web 的工具。

安装

Reference

• Asciidoctor Github official website
• Asciidoctor official website
• AsciiDoc 指引