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.[1] Common file extensions for AsciiDoc files are txt(as encouraged by AsciiDoc's creator) and adoc.[2][3]

AsciiDoc
Initial release2002 ?
Open format?yes
Websitehttp://asciidoc.org/
AsciiDoc
Developer(s)Stuart Rackham
Initial releaseNovember 25, 2002 (2002-11-25)
Stable release
9.0.0 / June 2, 2020 (2020-06-02)
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicenseGNU General Public License
Websiteasciidoc.org
Asciidoctor
Initial releaseJanuary 30, 2013 (2013-01-30)
Stable release
2.0.10 / June 1, 2019 (2019-06-01)
Repositoryhttps://github.com/asciidoctor/asciidoctor.git
Written inRuby
Operating systemCross-platform
TypeDocumentation generator
LicenseMIT License
Websiteasciidoctor.org

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

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
  • Antora - a multi-repository documentation site generator for tech writers using git.
  • AsciiBinder - (deprecated) a documentation system built on Asciidoctor for people who have a lot of docs to maintain and republish on a regular basis.
  • awestruct - a static site generator inspired by the Jekyll.

See also

References
  1. "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.



This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.