Formatting_Cheat-Sheet.md

orphan
true

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.¹
• This is an auto-numbered footnote reference.²

A longer footnote definition.³

---

Tabs

::::{tabs} :::{group-tab} macOS

test

::: :::{group-tab} Windows

test

::: ::::

---

Quotes and Codeblocks

This is a codeblock

this is code

this is a single line Quote

Links und Downloadlinks

Formatting Cheat Sheet

{download}`Title<Download_Link>`

---

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! :::

:::{seealso} See also here! :::

:::{admonition} Custom :class: tip Custom content :::

Footnotes

1. This is a manually-numbered footnote definition. ↩

2. This is an auto-numbered footnote definition. ↩

3. This is the footnote definition.

   That continues for all indented lines

   • even other block elements

   Plus any preceding unindented lines, that are not separated by a blank line ↩