AsciiDoc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
AsciiDoc
Initial release2002 ?
Open format?yes
Websitehttp://asciidoc.org/
AsciiDoc
Developer(s)Stuart Rackham
Initial releaseNovember 25, 2002; 17 years ago (2002-11-25)
Stable release
8.6.9 / November 9, 2013; 6 years ago (2013-11-09)
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicenseGNU General Public License
Websiteasciidoc.org
Asciidoctor
Initial releaseJanuary 30, 2013; 7 years ago (2013-01-30)
Stable release
2.0.10 / June 1, 2019; 10 months ago (2019-06-01)
Repositoryhttps://github.com/asciidoctor/asciidoctor.git
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] Common file extensions for AsciiDoc files are txt(as encouraged by AsciiDoc's creator) and adoc.[2][3]

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.[4] and GitLab[5]. 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.[6]

Most of the Git project documentation is written in AsciiDoc.[7]

Example[edit]

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

https://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

Tools[edit]

  • Antora[1] - a multi-repository documentation site generator for tech writers using git.
  • AsciiBinder[2] - (deprecated) a documentation system built on Asciidoctor for people who have a lot of docs to maintain and republish on a regular basis.
  • awestruct[3] - a static site generator inspired by the Jekyll.

See also[edit]

References[edit]

  1. ^ a b "AsciiDoc".
  2. ^ "AsciiDoc Frequently Asked Questions". asciidoc.org. Retrieved 2020-03-20.
  3. ^ "AsciiDoc Recommended Practices | Asciidoctor". asciidoctor.org. Retrieved 2020-03-20.
  4. ^ "AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories".
  5. ^ "Asciidoc". GitLab User Docs. Retrieved 6 Feb 2020.
  6. ^ "AsciiDoc 101 (chapter 4 of Getting Started with Atlas)". Author Welcome Kit. O'Reilly Media. Archived from the original on 14 October 2017. Retrieved 19 May 2016.
  7. ^ "Git wiki". Git SCM.

External links[edit]