| Filename extensions |
.adoc, .asciidoc, .txt |
|---|---|
| Internet media type |
text/asciidoc, text/plain |
| Initial release | 2002 |
| Open format? | yes |
| Website | asciidoc |
| Original author(s) | Stuart Rackham |
|---|---|
| Developer(s) | Matthew Peveler, Dan Allen, Michel Krämer, et al. |
| Initial release | November 25, 2002 |
| Stable release | 10.2.0[1] 
/ 22 May 2022 |
| Repository | github |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | GPL v2 |
| Website | asciidoc-py |
| Original author(s) | Ryan Waldron |
|---|---|
| Developer(s) | Dan Allen, Sarah White, et al. |
| Initial release | January 30, 2013 |
| Stable release | 2.0.20[2]
/ 18 May 2023 |
| 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.[3] Common file extensions for AsciiDoc files are txt (as encouraged by AsciiDoc's creator) and adoc.[4][5]
YouTube Encyclopedic
-
1/5Views:3 6839 4726 49510 821369
-
Markdown vs AsciiDoc
-
Creating PDFs Using Vim and AsciiDoc
-
der.hans: AsciiDoc - Plainish text for fancy output
-
AsciiDoc, let's get started
-
2023 - Asciidoc und Ascidoctor für Entwickler, Techniker und Admins
Transcription
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
|
| HTML-rendered result |
|---|
|
J. Smith Wikipedia is an on-line encyclopedia, 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.
- DAPS – DocBook Authoring and Publishing Suite (DAPS) is command-line software to publish DocBook & AsciiDoc as HTML, PDF, and EPUB.
See also
References
- ^ "Release 10.2.0". 22 May 2022. Retrieved 2 October 2022.
- ^ "Release 2.0.20". 18 May 2023. Retrieved 26 May 2023.
- ^ a b "AsciiDoc". Archived from the original on 2016-03-03. Retrieved 2013-10-18.
- ^ "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. Archived from the original on 2019-07-22. Retrieved 6 Feb 2020.
- ^ "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". 27 July 2020.
- ^ "AsciiDoc Working Group Charter".
External links
- Official website
- https://asciidoctor.org/
- Using AsciiDoc and Asciidoctor to write documentation - An AsciiDoc Tutorial
This page was last edited on 3 February 2024, at 16:47