AsciiDoc

AsciiDoc是Antora的本地内容标记语言。AsciiDoc非常适合撰写文档,因为它具有以下特点:

  • 易读

  • 简洁

  • 全面

  • 可扩展

  • 易于学习

语法

AsciiDoc是一种成熟、轻量级的标记语言,支持撰写技术文档所需的所有结构和语义元素。

AsciiDoc的语法直观易懂,因为它识别了用于标记和结构化文本的成熟的纯文本约定。不熟悉AsciiDoc的人应该能够通过查看大部分语法元素来理解其目的。这是因为这些语法元素经过精心选择,看起来就像它们的含义。

AsciiDoc只需要一个文本编辑器即可阅读或编写,因此非常容易上手。

解析器

Asciidoctor.js是将AsciiDoc内容转换为HTML和其他格式的处理器。

速度和安全性

没有提到Asciidoctor的速度就不完整。它加载、解析和转换文档非常迅速。这对于需要在日常基础上在多个环境中处理成千上万份文档的团队和应用程序来说是个好消息。Asciidoctor还提供了几个安全级别,进一步证明了它适用于服务器端部署的合理性。

开源的优势

Asciidoctor项目,即AsciiDoc语法、Asciidoctor.js及其扩展,是开源的,并在MIT许可下提供。Antora开发人员也是主要的Asciidoctor维护者,这有助于确保紧密集成,并使这两项技术不断发展以满足不断变化的文档需求。