README.adoc 1.65 KB
Newer Older
1
= AsciiDoc Language Project
Sarah White's avatar
Sarah White committed
2

3
4
5
6
This project maintains the AsciiDoc Language Specification, Technology Compatibility Kit (TCK), end 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 xref:process/scope.adoc[project's approved scope].
Sarah White's avatar
Sarah White committed
7

Sarah White's avatar
Sarah White committed
8
== Build the End User Documentation
9

Sarah White's avatar
Sarah White committed
10
The source files under the [.path]_docs/_ folder are organized into a documentation component as identified by the [.path]_antora.yml_ file.
11
To learn how to build this documentation using the playbook file [.path]_local-antora-playbook.yml_ with Antora, see the https://docs.antora.org/antora/latest/install-and-run-quickstart/[Install and Run Antora Quickstart].
12

Sarah White's avatar
Sarah White committed
13
14
15
16
17
18
19
20
21
== 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 link:LICENSE[] to find the full license text.

The end user documentation for the AsciiDoc Language, located in the [.path]_docs/_ folder, is made available under the terms of a https://creativecommons.org/licenses/by/4.0/[Creative Commons Attribution 4.0 International License] (CC-BY-4.0).

See xref:NOTICE.adoc[NOTICE] for additional license and copyright information.

Sarah White's avatar
Sarah White committed
22
23
== Trademarks

Sarah White's avatar
Sarah White committed
24
25
AsciiDoc and AsciiDoc Language are trademarks of the Eclipse Foundation.
Eclipse and the Eclipse Logo are registered trademarks of the Eclipse Foundation.