Jump to content
 







Main menu
   


Navigation  



Main page
Contents
Current events
Random article
About Wikipedia
Contact us
Donate
 




Contribute  



Help
Learn to edit
Community portal
Recent changes
Upload file
 








Search  

































Create account

Log in
 









Create account
 Log in
 




Pages for logged out editors learn more  



Contributions
Talk
 



















Contents

   



(Top)
 


1 History  





2 Asciidoctor  





3 Example  





4 Tools  





5 See also  





6 References  





7 External links  














AsciiDoc






Català
Čeština
Deutsch
Español
فارسی
Français

Italiano

Русский
Suomi
Українська

 

Edit links
 









Article
Talk
 

















Read
Edit
View history
 








Tools
   


Actions  



Read
Edit
View history
 




General  



What links here
Related changes
Upload file
Special pages
Permanent link
Page information
Cite this page
Get shortened URL
Download QR code
Wikidata item
 




Print/export  



Download as PDF
Printable version
 
















Appearance
   

 






From Wikipedia, the free encyclopedia
 


AsciiDoc file format
Filename extensions
.adoc, .asciidoc, .txt
Internet media type
text/asciidoc, text/plain
Initial release2002; 22 years ago (2002)
Open format?yes
Websiteasciidoc.org Edit this at Wikidata
AsciiDoc.py
Original author(s)Stuart Rackham
Developer(s)Matthew Peveler, Dan Allen, Michel Krämer, et al.
Initial releaseNovember 25, 2002; 21 years ago (2002-11-25)
Stable release

10.2.0[1] Edit this on Wikidata / 22 May 2022

Repositorygithub.com/asciidoc/asciidoc-py3
Written inPython
Operating systemCross-platform
TypeDocumentation generator
LicenseGPL v2
Websiteasciidoc-py.github.io
Asciidoctor
Original author(s)Ryan Waldron
Developer(s)Dan Allen, Sarah White, et al.
Initial releaseJanuary 30, 2013; 11 years ago (2013-01-30)
Stable release

2.0.23[2] Edit this on Wikidata / 17 May 2024

Repositorygithub.com/asciidoctor/asciidoctor
Written inRuby
Operating systemCross-platform
TypeDocumentation generator
LicenseMIT
Websiteasciidoctor.org

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]

History[edit]

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

ARuby 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[edit]

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

My Article

J. Smith

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

Tools[edit]

See also[edit]

References[edit]

  1. ^ "Release 10.2.0". 22 May 2022. Retrieved 2 October 2022.
  • ^ "Release 2.0.23". 17 May 2024. Retrieved 20 May 2024.
  • ^ 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[edit]



    Retrieved from "https://en.wikipedia.org/w/index.php?title=AsciiDoc&oldid=1202837952"

    Categories: 
    Free software programmed in Python
    Lightweight markup languages
    Hidden categories: 
    Articles with short description
    Short description is different from Wikidata
    Articles needing additional references from March 2014
    All articles needing additional references
     



    This page was last edited on 3 February 2024, at 16:47 (UTC).

    Text is available under the Creative Commons Attribution-ShareAlike License 4.0; additional terms may apply. By using this site, you agree to the Terms of Use and Privacy Policy. Wikipedia® is a registered trademark of the Wikimedia Foundation, Inc., a non-profit organization.



    Privacy policy

    About Wikipedia

    Disclaimers

    Contact Wikipedia

    Code of Conduct

    Developers

    Statistics

    Cookie statement

    Mobile view



    Wikimedia Foundation
    Powered by MediaWiki