AsciiDoc
 | This article needs additional citations for verification. (March 2014) |
| Internet media type | text/asciidoc |
|---|---|
| Initial release | 2002 |
| Free format? | yes |
| Website | asciidoc |
| Original author(s) | Stuart Rackham |
|---|---|
| Developer(s) | Dan Allen, Michel Krämer, et al. |
| Initial release | November 25, 2002 |
| Stable release | 9.0.4
/ October 20, 2020 |
| Repository | github |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | GPL v2 |
| Website | asciidoc |
| Original author(s) | Ryan Waldron |
|---|---|
| Developer(s) | Dan Allen, Sarah White, et al. |
| Initial release | January 30, 2013 |
| Stable release | 2.0.12
/ November 9, 2020 |
| Repository | github |
| Written in | Ruby |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | MIT |
| Website | asciidoctor |
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
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]
The Asciidoc format is currently under standardization procedure by the Eclipse Foundation.[8][9]
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 |
|---|
|
J. Smith Wikipedia is an on-line encyclopaedia, available in English and many other languages. You can install package-name using the gem command: gem install package-name Metals commonly used include:
|
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.
See also
References
- ^ a b "AsciiDoc".
- ^ "AsciiDoc Frequently Asked Questions". asciidoc.org. Retrieved 2020-03-20.
- ^ "AsciiDoc Recommended Practices | Asciidoctor". asciidoctor.org. Retrieved 2020-03-20.
- ^ "AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories".
- ^ "Asciidoc". GitLab User Docs. Retrieved 6 Feb 2020.
{{cite web}}: CS1 maint: url-status (link) - ^ "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.
- ^ "Git wiki". Git SCM.
- ^ "Asciidoc Language".
- ^ "AsciiDoc Working Group Charter".
External links
- Official website
- https://asciidoctor.org/
- Using AsciiDoc and Asciidoctor to write documentation - An Asciidoc Tutorial