AsciiDoc


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 and adoc.

History

AsciiDoc was created in 2002 by Stuart Rackham, who published tools, written in the Python programming language to convert plain-text, ‘human readable’ files to commonly used published document formats.
A Ruby implementation called ‘Asciidoctor’, released in 2013, is in use by GitHub and GitLab. 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.
Most of the Git project documentation is written in AsciiDoc.

Example

The following shows text using AsciiDoc mark-up, and a rendering similar to that produced by an AsciiDoc processor:

Software

You can install 'package-name' using
the `gem` command:
gem install package-name

Hardware

Metals commonly used include:

! HTML-rendered result

My Article

J. Smith

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

Tools