AsciiDoc

From Wikipedia, the free encyclopedia
Jump to: navigation, search
AsciiDoc
Developer(s) Stuart Rackham
Initial release November 25, 2002 (2002-11-25)
Stable release 8.6.9 / November 9, 2013; 10 months ago (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 0.1.4 / September 5, 2013; 12 months ago (2013-09-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[edit]

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[edit]

The following shows on the left, text using AsciiDoc mark-up, and on the right, a rendering of HTML produced by an AsciiDoc processor:

= 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
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[edit]

References[edit]

External links[edit]