AsciiDoc

AsciiDoc
Developer(s) Stuart Rackham
Initial release November 25, 2002 (2002-11-25)
Stable release
8.6.9 / November 9, 2013 (2013-11-09)
Written in Python
Operating system Cross-platform
Type Documentation generator
License GNU General Public License
Website asciidoc.org
AsciiDoctor
Initial release January 30, 2013 (2013-01-30)
Stable release
1.5.4 / January 5, 2016 (2016-01-05)
Written in Ruby
Operating system Cross-platform
Type Documentation generator
License MIT License
Website asciidoctor.org

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
My Article

J. Smith

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

See also

References

  1. 1 2 "AsciiDoc".
  2. ↑ "AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories".
  3. ↑ "AsciiDoc 101 (chapter 4 of Getting Started with Atlas)". Author Welcome Kit. O'Reilly Media. Retrieved 19 May 2016.
  4. ↑ "Git wiki". Git SCM.

External links

This article is issued from Wikipedia - version of the 12/3/2016. The text is available under the Creative Commons Attribution/Share Alike but additional terms may apply for the media files.