Skip to content

Commit 6429d08

Browse files
committed
Merged Formatting_Cheat-Sheet with README; Deleted Formatting_Cheat-Sheet
1 parent b285efd commit 6429d08

File tree

2 files changed

+111
-123
lines changed

2 files changed

+111
-123
lines changed

Formatting_Cheat-Sheet.md

Lines changed: 0 additions & 123 deletions
This file was deleted.

README.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,114 @@ Output can be found in `_build/html`.
2525
## Contributions
2626

2727
Contributions to this documentation are welcome. Please open a pull request.
28+
29+
---
30+
31+
## General Formatting Guidelines
32+
33+
Add an empty line...
34+
- ...after a heading
35+
- ...before and after an admonition or codeblock
36+
- ...after the admonition class for custom admonitions
37+
- ...after a tab opening and before a tab closing as shown in the [Tabs Section](#tabs)
38+
- ...before and after tables
39+
- ...before and after image inserts with custom properties
40+
41+
Indent codeblocks and admonitions within numbered lists, as the numbers aren't rendered correctly otherwise.
42+
43+
### Footnotes
44+
45+
- This is a manually-numbered footnote reference.[^3]
46+
- This is an auto-numbered footnote reference.[^myref]
47+
48+
[^myref]: This is an auto-numbered footnote definition.
49+
[^3]: This is a manually-numbered footnote definition.
50+
51+
A longer footnote definition.[^mylongdef]
52+
53+
[^mylongdef]: This is the _**footnote definition**_.
54+
55+
That continues for all indented lines
56+
57+
- even other block elements
58+
59+
Plus any preceding unindented lines,
60+
that are not separated by a blank line
61+
62+
### Tabs
63+
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.
64+
65+
```
66+
::::{tabs}
67+
:::{group-tab} macOS
68+
69+
text
70+
71+
:::
72+
:::{group-tab} Windows
73+
74+
text
75+
76+
:::
77+
::::
78+
```
79+
80+
Regular tabs are limited to the section and doesn't affect any other tabs on the page.
81+
82+
```
83+
::::{tabs}
84+
:::{tab} Text 1
85+
86+
text
87+
88+
:::
89+
:::{tab} Text 2
90+
91+
text
92+
93+
:::
94+
```
95+
96+
### Quotes and Code
97+
98+
````
99+
```
100+
This is a codeblock
101+
```
102+
````
103+
104+
`this is in line code`
105+
106+
```
107+
> this is a single line Quote
108+
```
109+
110+
### Links und Downloadlinks
111+
Add those inline into the text where needed.
112+
113+
```
114+
[Formatting Cheat Sheet](Formatting_Cheat-Sheet)
115+
```
116+
117+
```
118+
{download}`Title<Download_Link>`
119+
```
120+
121+
### Admonitions
122+
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
123+
124+
```
125+
:::{<type>}
126+
text
127+
:::
128+
```
129+
130+
Admonitions can also be used with custom titles by using the format below.
131+
132+
```
133+
:::{admonition} Custom Title
134+
:class: tip
135+
136+
text
137+
:::
138+
```

0 commit comments

Comments
 (0)