本项目维护AsciiDoc语言规范、技术兼容性测试套件(TCK)(独立的存储库)、用户文档及其相关材料。AsciiDoc语言规范描述了语法和语法结构、抽象语义图(ASG)、文档对象模型(DOM)、引用系统以及用于处理、转换和扩展语言的API。TCK用于验证和证明一个AsciiDoc处理器实现与本规范的兼容性。更多详情,请参见项目批准的范围

规格

规范的开发在 spec 文件夹以及问题跟踪器中进行。

处理文档

这个项目遵循Eclipse Foundation Specification Process (EFSP),该流程扩展了Eclipse Foundation Development Process (EFDP)。关于这一流程的总结,以及与该项目相关的具体细节,可以在[.path]_process_文件夹中找到。

TCK

虽然是同一个项目的一部分,但TCK(测试套件和测试)是在一个单独的仓库中维护的。参见 https://gitlab.eclipse.org/eclipse/asciidoc-lang/asciidoc-tck。

ASG的模式(schema),然而,是维护在这个仓库中。

用户文档

除了AsciiDoc语言规范之外,该项目还维护着AsciiDoc语言的用户文档。这个仓库中的[.path]_docs_文件夹包含了这份文档的源文件。

关于这份文档

在当前状态下,用户文档是来自Asciidoctor项目的初始贡献,它描述了Asciidoctor解释的AsciiDoc。用户文档本身并不是AsciiDoc语言规范。相反,它作为AsciiDoc语言规范将要开发出的参考资料。

虽然用户文档大多数情况下是准确的,但它不是一个技术规范,且仍然反映了AsciiDoc被Asciidoctor解释时的很多特性。AsciiDoc语言项目的一个关键目标是为AsciiDoc语言(其中包括语法规则和必须行为)开发一个独立于任何实现的技术规范。

一旦规范的首个版本完成后,用户文档将会更新以反映对语言所做的任何细化或更改。届时,用户文档很可能会被精简,专注于使用AsciiDoc而非定义它。换言之,它将继续作为规范的伴侣存在,面向那些想要学习如何使用AsciiDoc的人。

在线预览

这个仓库是在 docs.asciidoctor.org 的剧本文件 中注册的内容源。位于 docs/ 文件夹下的源文件按照 antora.yml 文件所识别的文档组件进行组织。你可以在 https://docs.asciidoctor.org/asciidoc/latest 网上查看其发布的版本。

本地预览

要在本地构建和预览文档,请遵循仓库根目录下文件 local-antora-playbook.yml 中的说明。要了解更多关于如何使用Antora构建文档站点的信息,请参阅 安装和运行 Antora 快速入门

执照

AsciiDoc 语言和附带的材料是根据 Eclipse 公共许可证版本 2.0 (EPL-2.0) 的条款提供的。请查看链接:LICENSE[] 找到完整的许可证文本。

AsciiDoc 语言的用户文档位于[.path]docs/ 文件夹中,根据 Creative Commons Attribution 4.0 International License (CC-BY-4.0) 的条款提供。

查看通知以获得额外的许可和版权信息。

商标

AsciiDoc®和AsciiDoc Language™是Eclipse Foundation, Inc.的商标。