AsciiDoc Quick Reference

泓熠 (HY)

Copyright © 2026, 泓熠 (HY).
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

Annotations


// The annotation content.

			

Captions


= The caption of 1st level, which should be unique.
== The caption of 2ed level.
=== The caption of 3rd level.
==== The caption of 4th level.
===== The caption of 5th level.
====== The caption of 6th level.

			

Code Block


[sourse, Python]  // This is language name.
----
<This is code block content.>
----

			

Bold


*This is bold content.*

			

Italic


_This is Italic content_

			

Underline Content


[underline]#This is underline content.

			

Superscript and Subscript


^This is superscript.^
~This is subscript~

			

Lists


. This is the 1st item in a ordered list.
. This is the 2ed item in a ordered list.
* This is a item in a unordered list.
* This is a item in a unordered list.

			

Tables


[options="header,footer", cols="1,2,3"] 
|===
|1   |2   |3
|a   |b   |c
|x   |y   |z
|m   |n   |o
|===

			

Links


https://www.example.com[This is the shown content.]

			

Important Content


[IMPORTANT]
====
This is important content.
====

			

"Column"


.This is caption of "column".
****
This is the content of "column".
****

			

"Examples"


.This is the caption of "example".
====
This is the content of "example".
====

			

"Pass"


++++
This is the content of "Pass".
++++  

			

Quote


[quote,This is the source of quote.]
____
This is the content of quote.
____

			

Tips


[TIP]
====
This is the content of tips.
====

			

Caution


[CAUTION]
====
This the content of caution.
====

			

Warining


[WARNING]
====
This is the content of warning.
====

			

Glossary


[glossary]
This is the name of glossary::
	This is the meaning of glossary

			

Paragraph

The blank line means paragraph.