Description #
AsciiDoc is a plain-text markup language designed for writing documentation, articles, and books. It allows authors to write structured content using simple syntax, which can be converted to HTML, PDF, or other formats.
History #
AsciiDoc was created in the early 2000s by Stuart Rackham to simplify technical documentation. Its popularity grew in open-source communities, especially with the rise of Asciidoctor, a fast Ruby-based implementation.
Hello World Code #
= Hello, World!
Author Name
This is a simple AsciiDoc document.
== Introduction
Hello, World!How to Run #
Option 1: Online
Use the Asciidoctor web editor: https://asciidoclive.com/
Option 2: Local
Install Asciidoctor:
gem install asciidoctorConvert .adoc to HTML:
asciidoctor hello.adocKey Concepts #
- Lightweight markup for structured documents
- Headers:
=,==,===denote levels - Inline formatting with
*bold*,_italic_,+monospace+ - Supports tables, images, code blocks, footnotes
- Converts to HTML, DocBook, PDF, EPUB
- Highly customizable with styles and templates
- Used in GitHub, GitLab, Antora
- Ideal for tech docs, READMEs, and publishing
- Compatible with CI/CD pipelines
- Multiple implementations (Python, Ruby, Java)
Try It Online #
Fun Facts #
- AsciiDoc can be used to write entire books, and many O’Reilly titles were written with it.
- It’s the default format for the popular Antora documentation site generator.
- Compared to Markdown, AsciiDoc supports more advanced document features natively.
Resources #
Official site
Docs or tutorial
GitHub or interpreter
Community or learning resources
