AsciiDoc Live Editor & Preview

AsciiDoc Reference

This quick reference summarizes a few common AsciiDoc elements to help you get started. For a complete guide, consult the official documentation.

Section Titles & Levels

Use one or more equal signs at the beginning of a line to set the section level. The number of equal signs corresponds to the depth: a single = indicates the document title (level 0), == denotes a top‑level section, === a subsection, and so on. Keep levels nested in order and avoid skipping levels【414192497846188†L340-L352】.

Bold & Italic Text

Surround a word or phrase with single asterisks to make it bold (*bold*). Use single underscores for italic emphasis (_italic_). When emphasising characters inside a word, double the markup: char**act**er for bold characters and char__act__er for italics【835454342988876†L325-L334】【845073801389674†L324-L333】.

Unordered Lists

To create a bulleted list, prefix each item with an asterisk followed by a space. Nested lists are created by adding additional asterisks; for example, * for top‑level items, ** for sub‑items, and so on【826817131712020†L327-L342】【826817131712020†L409-L417】.

* Edgar Allan Poe
* H. P. Lovecraft
** The Call of Cthulhu
** At the Mountains of Madness

Code Blocks

Use a delimited listing block for code. Start and end the block with a line of four hyphens. The content inside is rendered within a preformatted element and preserved verbatim【857853945951099†L352-L361】.

----
def hello(name):
    print(f"Hello, {name}!")
----

Links

To create a hyperlink, wrap the target URL or file in the link: macro. If the target begins with a URL scheme like https:, the macro prefix can be omitted. Specify link text in brackets after the target【359027449880835†L613-L619】.

link:https://example.com[Example]
https://example.com[Example without macro]
link:index.html[Docs]

Editor

HTML

PDF

Preview