AsciiDoc
This article needs additional citations for verification. (March 2014) |
Developer(s) | Stuart Rackham |
---|---|
Initial release | November 25, 2002 |
Stable release | 8.6.9
/ November 9, 2013 |
Repository | |
Written in | Python |
Operating system | Cross-platform |
Type | Documentation generator |
License | GNU General Public License |
Website | asciidoc |
Initial release | January 30, 2013 |
---|---|
Stable release | 1.5.2
/ November 27, 2014 |
Repository | |
Written in | Ruby |
Operating system | Cross-platform |
Type | Documentation generator |
License | MIT License |
Website | asciidoctor |
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.[1]
History
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.[1]
A Ruby implementation called ‘Asciidoctor’, released in 2013, is in use by GitHub[2] and also provides a gateway to Asciidoc use in the Java ecosystem.
Some of O'Reilly Media's books and e-books are authored using AsciiDoc mark-up.[3]
Most of the Git documentation is written in AsciiDoc.[4]
Example
The following shows text using AsciiDoc mark-up, and a rendering similar to that produced by an AsciiDoc processor:
Asciidoc source text |
---|
= My Article J. Smith http://wikipedia.org[Wikipedia] is an on-line encyclopaedia, available in English and many other languages. == Software You can install 'package-name' using the +gem+ command: gem install package-name == Hardware Metals commonly used include: * copper * tin * lead |
HTML-rendered result |
---|
Per WP:PSEUDOHEADING fake headings should not be used in articles. J. Smith Wikipedia is an on-line encyclopaedia, available in English and many other languages. Per WP:PSEUDOHEADING fake headings should not be used in articles. You can install package-name using the gem command: gem install package-name Per WP:PSEUDOHEADING fake headings should not be used in articles. Metals commonly used include:
|
See also
References
External links
- Official website
- Asciidoc “cheat-sheet” reference guide
- MPLW - Matplotlib charting filter for AsciiDoc
- RTextDoc. Editor with AsciiDoc support.
- AsciidocToGo. Frontend to convert AsciiDoc txt files