Merge pull request #562 from iterate-ch/issue/532

Reviewed Formatting

Author: dkocher

Formatting_Cheat-Sheet.md

@@ -5,6 +5,20 @@ 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](#tabs)
+- ...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]
@@ -28,19 +42,18 @@ that are not separated by a blank line
 
 ## Tabs
 
-````{tabs}
-
-```{group-tab} macOS
+::::{tabs}
+:::{group-tab} macOS
 
 test
-```
 
-```{group-tab} Windows
+:::
+:::{group-tab} Windows
 
 test
-```
 
-````
+:::
+::::
 
 ---
 
@@ -64,47 +77,47 @@ test
 
 ## Admonitions
 
-```{note}
+:::{note}
 Here is a note!
-```
+:::
 
-```{warning}
+:::{warning}
 Here is a warning!
-```
+:::
 
-```{tip}
+:::{tip}
 Here is a tip!
-```
+:::
 
-```{caution}
+:::{caution}
 Caution!
-```
+:::
 
-```{attention}
+:::{attention}
 Attention!
-```
+:::
 
-```{danger}
+:::{danger}
 Here is a danger!
-```
+:::
 
-```{error}
+:::{error}
 Here is an error!
-```
+:::
 
-```{hint}
+:::{hint}
 Here is a hint!
-```
+:::
 
-```{important}
+:::{important}
 This is important!
-```
+:::
 
-```{seealso}
+:::{seealso}
 See also here!
-```
+:::
 
-```{admonition} Custom
+:::{admonition} Custom
 :class: tip
 Custom content
-```
+:::