Jump to content

AsciiDoc

From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by 82.199.53.68 (talk) at 12:35, 26 October 2015 (→‎Example). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

AsciiDoc
Developer(s)Stuart Rackham
Initial releaseNovember 25, 2002; 21 years ago (2002-11-25)
Stable release
8.6.9 / November 9, 2013; 10 years ago (2013-11-09)
Repository
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicenseGNU General Public License
Websiteasciidoc.org
AsciiDoctor
Initial releaseJanuary 30, 2013; 11 years ago (2013-01-30)
Stable release
1.5.2 / November 27, 2014; 9 years ago (2014-11-27)
Repository
Written inRuby
Operating systemCross-platform
TypeDocumentation generator
LicenseMIT License
Websiteasciidoctor.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

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:

  • copper
  • tin
  • lead

See also

References

  1. ^ a b "AsciiDoc".
  2. ^ "AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories".
  3. ^ "O'Reilly Author Portal -- Welcome Kit: Writing in AsciiDoc".
  4. ^ "Git wiki". Git SCM.