diff --git a/Formatting_Cheat-Sheet.md b/Formatting_Cheat-Sheet.md deleted file mode 100644 index ee8f4f14..00000000 --- a/Formatting_Cheat-Sheet.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -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] -- This is an auto-numbered footnote reference.[^myref] - -[^myref]: This is an auto-numbered footnote definition. -[^3]: This is a manually-numbered footnote definition. - -A longer footnote definition.[^mylongdef] - -[^mylongdef]: 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 - ---- - -## 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](Formatting_Cheat-Sheet) - -``` -{download}`Title` -``` - ---- - -## 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 -::: \ No newline at end of file diff --git a/README.md b/README.md index 53fe1e4c..abc5dc37 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,114 @@ Output can be found in `_build/html`. ## Contributions Contributions to this documentation are welcome. Please open a pull request. + +--- + +## 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 + +Indent codeblocks and admonitions 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.[^myref] + +[^myref]: This is an auto-numbered footnote definition. +[^3]: This is a manually-numbered footnote definition. + +A longer footnote definition.[^mylongdef] + +[^mylongdef]: 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 + +### Tabs +Group tabs allow to select a tab for the whole page. As an example: If a page contains three group tabs with macOS and Windows as options and you select macOS for one section then all the sections on the page will switch to macOS. + +``` +::::{tabs} +:::{group-tab} macOS + +text + +::: +:::{group-tab} Windows + +text + +::: +:::: +``` + +Regular tabs are limited to the section and doesn't affect any other tabs on the page. + +``` +::::{tabs} +:::{tab} Text 1 + +text + +::: +:::{tab} Text 2 + +text + +::: +``` + +### Quotes and Code + +```` +``` +This is a codeblock +``` +```` + +`this is in line code` + +``` +> this is a single line Quote +``` + +### Links und Downloadlinks +Add those inline into the text where needed. + +``` +[Formatting Cheat Sheet](Formatting_Cheat-Sheet) +``` + +``` +{download}`Title` +``` + +### Admonitions +Admonitions are boxes with a colored background that highlight information. Available admonition types are: note, warning, tip, caution, attention, danger, error, hint, important, and seealso + +``` +:::{} +text +::: +``` + +Admonitions can also be used with custom titles by using the format below. + +``` +:::{admonition} Custom Title +:class: tip + +text +::: +``` \ No newline at end of file