AsciiDoc Syntax Reference

Help improve this page

To contribute to this user guide, choose the Edit this page on GitHub link that is located in the right pane of every page.

Help improve this page

To contribute to this user guide, choose the Edit this page on GitHub link that is located in the right pane of every page.

This page is a quick overview of AsciiDoc syntax.

We suggest using AsciiDoc syntax. The AsciiDoc tooling has partial support for Markdown syntax, including headings and lists.

For advanced syntax, review the AsciiDoc Website.

It’s important to get the link syntax right for the AWS docs. Review how to Insert a link. You cannot use Markdown syntax for links.

Basic formatting

*bold text*
_italic text_
`monospace text`

Headers

= Document Title (Header 1)
== Header 2
=== Header 3
==== Header 4
===== Header 5
====== Header 6

Lists

Unordered Lists:

- Item 1
- Item 2
-- Subitem 2.1
-- Subitem 2.2
- Item 3

Ordered Lists:

. First item
. Second item
.. Subitem 2.1
.. Subitem 2.2
. Third item

Links

External link: https://example.com[Link text]
Internal link: <<page-id>>
Internal link: <<page-id,Link text>>

Images

image::image-file.jpg[Alt text]

Code Blocks

 [source,python]
 ----
 def hello_world():
     print("Hello, World!")
 ----

Tables

Learn how to build a basic table.

[cols="1,1"]
|===
|Cell in column 1, row 1
|Cell in column 2, row 1

|Cell in column 1, row 2
|Cell in column 2, row 2

|Cell in column 1, row 3
|Cell in column 2, row 3
|===

Admonitions

NOTE: This is a note admonition.

WARNING: This is a warning admonition.

TIP: This is a tip admonition.

IMPORTANT: This is an important admonition.

CAUTION: This is a caution admonition.

Preview:

Includes

 include::filename.adoc[]