AsciiDoc是轻量级标记语言,使用文本编辑器书写。
Asciidoctor是基于Ruby
编程语言的开源处理器,它读取AsciiDoc文本,然后将其转化为指定的可发布格式,比如:HTML 5、PDF 和 EPUB 3 等。
Asciidoctor.js是把Asciidoctor由Ruby
实现转化为JavaScript
实现,可用于所有支持JavaScript
的平台,将AsciiDoc文档转化为HTML。本站使用的即是Asciidoctor.js,但并非官方版本,而是经过少量修改的版本。
本站大多数页面均使用 AsciiDoc 编写,这可以快速实现诸多复杂的HTML格式。
虽然 Asciidoctor 基于 Ruby 语言开发,但同时发布了可在其他平台运行的版本。比如用 Asciidoctor.js 在任意支持 JavaScript 的环境中配置。
Asciidoctor 的官方网站为 asciidoctor.org ,它的完整手册可见 docs.asciidoctor.org 。
最流行的轻量级标记语言是 Markdown,但随着时代的发展,Markdown 简单的功能已经不能满足复杂的格式需求。为了实现更丰富的格式,开发者必须为 Markdown 不断安装插件,这会使语法逐渐复杂,并且可移植性差。
AsciiDoc 比 Markdown 支持更多的格式,实现相同格式的代码相同复杂或更简洁,并且代码风格更加一致。
本指南由 AsciiDoc 语法官方指南 汉化而来,并重新调整了行文逻辑、结构与例子,使文章详略得当,且更容易理解和学习。
AsciiDoc 支持多种样式,且可以渲染成多种可发布格式。但是 Asciidoctor 将 AsciiDoc 渲染成 HTML 5 代码时,不支持 AsciiDoc 针对其他样式的格式。不仅如此,渲染后的 HTML 5 代码的 CSS 样式由网站开发人员指定,这使得相同的 AsciiDoc 文件在不同网站内渲染出的样式有所不同。
对于春语实验室网站不支持的格式,该指南会明确指出。