Skip to content

Commit

Permalink
Merged Formatting_Cheat-Sheet with README; Deleted Formatting_Cheat-S…
Browse files Browse the repository at this point in the history
…heet
  • Loading branch information
tatze96 committed Sep 17, 2024
1 parent b285efd commit 6429d08
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 123 deletions.
123 changes: 0 additions & 123 deletions Formatting_Cheat-Sheet.md

This file was deleted.

111 changes: 111 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<Download_Link>`
```

### 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

```
:::{<type>}
text
:::
```

Admonitions can also be used with custom titles by using the format below.

```
:::{admonition} Custom Title
:class: tip
text
:::
```

0 comments on commit 6429d08

Please sign in to comment.