Formatting Cheat Sheet

General Formatting Guidelines

Add an empty line…

  • …after a heading

  • …before and after an admonition or codeblock

  • …after the admonition class for custom admonitions

  • …after a tab opening and before a tab closing as shown in the Tabs Section

  • …before and after tables

  • …before and after image inserts with custom properties

Don’t add an empty line around admonitions within lists

Indent codeblocks within numbered lists, as the numbers aren’t rendered correctly otherwise.

Footnotes

  • This is a manually-numbered footnote reference.[3]

  • This is an auto-numbered footnote reference.[1]

A longer footnote definition.[2]

Tabs

test

Quotes and Codeblocks

This is a codeblock

this is code

this is a single line Quote

Admonitions

Note

Here is a note!

Warning

Here is a warning!

Tip

Here is a tip!

Caution

Caution!

Attention

Attention!

Danger

Here is a danger!

Error

Here is an error!

Hint

Here is a hint!

Important

This is important!

See also

See also here!

Custom

Custom content