AsciiDoc Language Project
This project maintains the AsciiDoc Language Specification, Technology Compatibility Kit (TCK), user documentation, and their related materials. The AsciiDoc Language Specification describes the syntax and grammar, Abstract Semantic Graph (ASG), Document Object Model (DOM), referencing system, and APIs for processing, converting, and extending the language. The TCK is used to verify and certify that an AsciiDoc processor implementation is compatible with this specification. For further details, see the project’s approved scope.
User Documentation
In addition to the AsciiDoc Language Specification, this project maintains the user documentation for the AsciiDoc language. The docs folder in this repository contains the source of this documentation.
About this Documentation
In it’s current state, the user documentation is the initial contribution from the Asciidoctor project that describes AsciiDoc as interpreted by Asciidoctor. The user documentation is not itself the AsciiDoc Language Specification. Rather, it serves as the reference material from which the AsciiDoc Language Specification will be developed.
While the user documentation is mostly accurate, it’s not a technical specification and still reflects many idiosyncrasies of how AsciiDoc is interpreted by Asciidoctor. A key goal of the AsciiDoc Language project is to develop a technical specification for the AsciiDoc language (which includes grammar rules and required behavior) that’s independent of any implementation.
Once the first version of the specification is complete, the user documentation will be updated to reflect any refinements or changes that were made to the language. At that time, the user documentation will likely be slimmed down to focus exclusively on using AsciiDoc rather than defining it. In other words, it will continue to serve as a companion to the specification, intended for those who want to learn how to use AsciiDoc.
Online Preview
This repository is a registered content source in the playbook file for docs.asciidoctor.org. The source files under the docs/ folder are organized into a documentation component as identified by the antora.yml file. You can view the published version online at https://docs.asciidoctor.org/asciidoc/latest.
Local Preview
To build and preview the documentation locally, follow the instructions in the file local-antora-playbook.yml at the root of this repository. To learn more about how to build a documentation site with Antora, see the Install and Run Antora Quickstart.
Licenses
The AsciiDoc Language and the accompanying materials are made available under the terms of the Eclipse Public License v 2.0 (EPL-2.0). See LICENSE to find the full license text.
The user documentation for the AsciiDoc Language, located in the docs/ folder, is made available under the terms of a Creative Commons Attribution 4.0 International License (CC-BY-4.0).
See NOTICE for additional license and copyright information.