AsciiDoc file format | |
Screenshot Size: | A_B |
Extensions: | .adoc, .asciidoc, .txt |
Mime: | text/asciidoc, text/plain |
Standards: | --> |
Open: | yes |
AsciiDoc.py | |
Author: | Stuart Rackham |
Developer: | Matthew Peveler, Dan Allen, Michel Krämer, |
Programming Language: | Python |
Operating System: | Cross-platform |
Genre: | Documentation generator |
License: | GPL v2 |
Asciidoctor | |
Author: | Ryan Waldron |
Developer: | Dan Allen, Sarah White, |
Programming Language: | Ruby |
Operating System: | Cross-platform |
Genre: | Documentation generator |
License: | MIT |
AsciiDoc is a human-readable document format, semantically equivalent to DocBook XML, but using plain-text mark-up conventions. AsciiDoc documents can be created using any text editor and read “as-is”, or rendered to HTML or any other format supported by a DocBook tool-chain, i.e. PDF, TeX, Unix manpages, e-books, slide presentations, etc. Common file extensions for AsciiDoc files are txt
(as encouraged by AsciiDoc's creator) and adoc
.[1] [2]
AsciiDoc was created in 2002 by Stuart Rackham, who published tools (‘asciidoc’ and ‘a2x’), written in the Python programming language to convert plain-text, ‘human readable’ files to commonly used published document formats.[3]
A Ruby implementation called ‘Asciidoctor’, released in 2013, is in use by GitHub[4] and GitLab.[5] This implementation is also available in the Java ecosystem using JRuby and in the JavaScript ecosystem using Opal.js.
Some of O'Reilly Media's books and e-books are authored using AsciiDoc mark-up.[6]
Most of the Git project documentation is written in AsciiDoc.[7]
The AsciiDoc format is currently under standardization procedure by the Eclipse Foundation.[8] [9]
The following shows text using AsciiDoc mark-up, and a rendering similar to that produced by an AsciiDoc processor: