AsciiDoc

AsciiDoc

AsciiDoc

Human-readable document format

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

Quick Facts Filename extensions, Internet media type ...
Quick Facts Original author(s), Developer(s) ...
Quick Facts Original author(s), Developer(s) ...

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.[3]

Asciidoctor

A Ruby implementation called ‘Asciidoctor’, released in 2013, is in use by GitHub[6] and GitLab.[7] 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.[8]

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

The AsciiDoc format is currently under standardization procedure by the Eclipse Foundation.[10][11]

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 encyclopedia, 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
More information HTML-rendered result ...

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 Jekyll.
  • Asciidoc FX – AsciiDoc Book Editor based on JavaFX 8.
  • AsciiDocLIVE – AsciiDocLIVE is a free online AsciiDoc editor.
  • DAPS – DocBook Authoring and Publishing Suite (DAPS) is command-line software to publish DocBook & AsciiDoc as HTML, PDF, and EPUB.

See also

References

  1. [1]
    "Release 10.2.0". 22 May 2022. Retrieved 2 October 2022.
  2. [2]
    "Release 2.0.22". 8 March 2024. Retrieved 19 March 2024.
  3. [3]
    "AsciiDoc". Archived from the original on 2016-03-03. Retrieved 2013-10-18.
  4. [4]
    "AsciiDoc Frequently Asked Questions". asciidoc.org. Retrieved 2020-03-20.
  5. [5]
    "AsciiDoc Recommended Practices | Asciidoctor". asciidoctor.org. Retrieved 2020-03-20.
  6. [6]
    "AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories".
  7. [7]
    "Asciidoc". GitLab User Docs. Archived from the original on 2019-07-22. Retrieved 6 Feb 2020.
  8. [8]
    "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.
  9. [9]
    "Git wiki". Git SCM.
  10. [10]
    "AsciiDoc Language". 27 July 2020.
  11. [11]
    "AsciiDoc Working Group Charter".
Share this article:

This article uses material from the Wikipedia article AsciiDoc, and is written by contributors. Text is available under a CC BY-SA 4.0 International License; additional terms may apply. Images, videos and audio are available under their respective licenses.