-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
--- | ||
title: Home | ||
subtitle: 3D City Database v5 documentation | ||
description: | ||
# icon: material/emoticon-happy | ||
# status: | ||
# new: Recently added | ||
--- | ||
|
||
## Content | ||
|
||
## Usage instructions | ||
|
||
In dieser Sektion findest du Hinweise, wie du effektiv mit der Prozessdokumentation arbeiten kannst. | ||
|
||
### How to search | ||
|
||
Die effizienteste Möglichkeit Dinge in der Dokumentation zu finden, ist die Suchfunktion. Nur ein Schlagwort wird in vielen Fällen schon ausreichen, um die richtige Seite zu finden. | ||
|
||
#### Keyboard shortcuts | ||
|
||
Die großartige [Suchfunktion](https://squidfunk.github.io/mkdocs-material/plugins/search/){target="_blank"} lässt sich komfortabel über die Tastatur steuern. | ||
Das gleich gilt für die Navigation zwischen Seiten. Für die Suchfunktion gibt zwei Modi: | ||
|
||
: Dieser Modus ist aktiv, wenn die _Suche fokussiert_ ist. Er bietet mehrere Tasten, um die Suche über die Tastatur zugänglich und navigierbar zu machen: | ||
|
||
* ++arrow-down++ , ++arrow-up++ : Nächstes/Vorheriges Suchergebnis auswählen | ||
* ++esc++ , ++tab++ : Suchdialog schließen | ||
* ++enter++ : Suchergebnis öffnen | ||
|
||
: Dieser Modus ist aktiv, wenn _Suche nicht fokussiert ist_ und wenn es kein anderes fokussiertes Element gibt, das für Tastatureingaben empfänglich ist. Die folgenden Tasten sind gebunden: | ||
|
||
* ++f++ , ++s++ , ++slash++ : Suchdialog öffnen | ||
* ++p++ , ++comma++ : Nächste Seite | ||
* ++n++ , ++period++ : Vorherige Seite | ||
|
||
[Hier](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=keyboard#keyboard-shortcuts){target="_blank"} gibt es weitere Infos zur Erstellung von eigenen Tastenkombinationen. | ||
|
||
## How to contribute | ||
|
||
- 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](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet){target="_blank"} | ||
- [Markdown cheatsheet printable](https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf){target="_blank"} | ||
- [MkDocs Materials Theme documentation](https://squidfunk.github.io/mkdocs-material/){target="_blank"} | ||
- [User Guide MkDocs](https://www.mkdocs.org/user-guide){target="_blank"} | ||
|
||
### Markdown examples | ||
|
||
Hier ein Beispiel: | ||
|
||
``` markdown title="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. ... | ||
|
||
``` |