 | This articleneeds additional citations forverification. Please helpimprove this article byadding citations to reliable sources. Unsourced material may be challenged and removed. Find sources: "AsciiDoc" – news ·newspapers ·books ·scholar ·JSTOR(March 2014) (Learn how and when to remove this message) |
| AsciiDoc file format | |
|---|---|
| Filename extensions | .adoc, .asciidoc, .txt |
| Internet media type | text/asciidoc, text/plain |
| Initial release | November 25, 2002; 23 years ago (2002-11-25) |
| Open format? | Yes |
| Website | asciidoc |
| Asciidoctor | |
|---|---|
| Original author | Ryan Waldron |
| Developers | Dan Allen, Sarah White,et al. |
| Initial release | January 30, 2013; 12 years ago (2013-01-30) |
| Stable release | 2.0.26[1] / 24 October 2025 |
| Repository | github |
| Written in | Ruby |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | MIT |
| Website | asciidoctor |
AsciiDoc is ahuman-readable document format, semantically equivalent toDocBookXML, but usingplain textmark-up conventions. AsciiDoc documents can be created using anytext editor and read “as-is”, or rendered toHTML or any other format supported by a DocBook tool-chain, i.e.,PDF,TeX,Unixmanpages,e-books, slide presentations, etc.[2] Common file extensions for AsciiDoc files areadoc[3] and historicallytxt (as encouraged by AsciiDoc's creator).[4]
The AsciiDoc format is being standardized by theEclipse Foundation.[5][6]
| AsciiDoc.py | |
|---|---|
| Original author | Stuart Rackham |
| Developers | Matthew Peveler, Dan Allen, Michel Krämer,et al. |
| Initial release | November 25, 2002; 23 years ago (2002-11-25) |
| Stable release | 10.2.1[7] / 17 July 2024 |
| Repository | github |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | GPL v2 |
| Website | asciidoc-py |
AsciiDoc was created in 2002 by Stuart Rackham, who published tools (asciidoc anda2x), written in theprogramming languagePython to convert plain text,human readable files to commonly used published document formats.[2]
Implementations also exist inRuby (namedAsciidoctor, released in 2013), theJava ecosystem viaJRuby, theJavaScript ecosystem via Opal.js, and inHaskell andGo.
Since the start of thetechnical standardizing process in 2019, the Asciidoctor project has aimed to produce anindependent, compatible implementation
of the AsciiDoc specification in the making, with the support of Stuart Rackham, the original author of the language.[8] The official website of the AsciiDoc language has since begun linking to Asciidoctor's documentation of the language.
The start of the standardizing process in 2019 coincided with the release of Asciidoctor 2.0 and several parts ofsyntax being deprecated, such as single quotation marks (') to indicate italics.[9] Legacy syntax remains available through a compatibility mode.[10]
The original Python implementation by Stuart Rackham continues to be developed, and namedAsciiDoc.py. Since 2021, its documentation describes it aslegacy
, and formally targets the older rendition of the language.[11]
![[icon]](/mt/?noimg=&dark=on&url=https%3a%2f%2fen.wikipedia.org%2fwiki%2fFile%3aWiki_letter_w_cropped.svg) | This sectionneeds expansion. You can help byadding to it.(March 2025) |
Most of theGit project documentation is written in AsciiDoc.[12]
Some ofO'Reilly Media's books and e-books are authored using AsciiDoc mark-up.[13]
Red Hat's product documentationis written in AsciiDoc.
Asciidoctor is usable withinGitHub[14] andGitLab.[15]
The following shows text using AsciiDoc mark-up, and a rendering similar to that produced by an AsciiDoc processor:
| AsciiDoc source text |
|---|
= My ArticleJ. Smithhttps://wikipedia.org[Wikipedia] is anon-line encyclopedia, available inEnglish and *many* other languages.== SoftwareYou can install _package-name_ by usingthe `gem` command: gem install package-name== HardwareMetals commonly used include:* copper* tin* lead |
| HTML-rendered result |
|---|
My Article J. Smith Wikipedia is an on-line encyclopedia,available in English andmany other languages. Software You can installpackage-name by using the gem install package-name Hardware Metals commonly used include:
|
