What is AsciiDoc

AsciiDoc is a lightweight markup language that is easy for both humans and AI to read and write. Here are its core constructs, shown side by side: source on the left, rendered output on the right.

Headings & paragraphs

Source (.adoc)

= Document title (level 0)

A plain paragraph. Use *bold* and _italic_ inline.

== Level 1 heading

=== Level 2 heading

Level 2 headings use "===".

Rendered HTML

Table of Contents

Level 1 heading
- Level 2 heading

A plain paragraph. Use bold and italic inline.

Level 1 heading

Level 2 heading

Level 2 headings use "===".

Admonitions

Source (.adoc)

[NOTE]
====
A supplementary note. AI agents pick these structures out reliably.
====

[WARNING]
A warning for newcomers.

Rendered HTML

A supplementary note. AI agents pick these structures out reliably.

A warning for newcomers.

Tables

Source (.adoc)

[cols="2,2"]
|===
| Format | Characteristic

| AsciiDoc
| Explicit structure

| Markdown
| Space-sensitive, ambiguous
|===

Rendered HTML

Format	Characteristic
AsciiDoc	Explicit structure
Markdown	Space-sensitive, ambiguous

Format

Characteristic

AsciiDoc

Explicit structure

Markdown

Space-sensitive, ambiguous

Source code

Source (.adoc)

[source,bash]
----
$ asciidoctor my-doc.adoc
----

Rendered HTML

$ asciidoctor my-doc.adoc

Math (stem)

Source (.adoc)

STEM: e^{i\pi} + 1 = 0

Rendered HTML

STEM: e^{i\pi} + 1 = 0

Try it in the Playground →