Usage and contribution

This documentation is made with mkdocs and mkdocs-material. Here you will find instructions on how to work effectively with the documentation and how to contribute.

Search and page navigation

The most efficient way to find things in the documentation is to use the search function. In many cases, just one keyword will be enough to find the right page. You can access the search function using the search bar at the top or keyboard shortcuts.

Keyboard shortcuts

The search function can be conveniently controlled via the keyboard. The same applies to navigation between pages. There are two modes for the search function:

This mode is active when the search bar is focused. It offers several keys to make the search accessible and navigable via the keyboard:

• Down , Up : Select next/previous search result
• Esc , Tab : Close search dialog
• Enter : Open search result

This mode is active when search bar is not focused and when there is no other focused element that is receptive to keyboard input. The following keys are bound:

• F , S , / : Open search dialog
• P , , : Next page
• N , . : Previous page

See here for more information on creating your own key combinations.

How to contribute

Setup development environment

• VS Code und Extensions auflisten!

Diese Dokumentation wurde mit Materials für MkDocs erstellt. Der Inhalt ist in Markdown, einer vereinfachten Auszeichnungssprache geschrieben, deren Grundelemente in 15 min erlernt werden können.

• Markdown Referenz
• Markdown cheatsheet printable
• MkDocs Materials Theme documentation
• User Guide MkDocs

Markdown examples

Hier ein Beispiel:

Ein Beispiel Markdown dokument

# Überschrift Ebene 1

Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

## Überschrift Ebene 2

Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

### Überschrift Ebene 3

Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

#### Überschrift Ebene 4

Eine Aufzählung:

- Punkt 1

    - Unterpunkt 1
    - Unterpunkt 2

        - Unterunterpunkt 1
        - ...

- Punkt 2
- ...

Eine Nummerierung:

1. Punkt 1

    1. Unterpunkt 1
    2. Unterpunkt 2

2. Punkt 2
3. ...