TEAM Bereich¶
Anleitung für mkdocs¶
sozusagen die Doku zur Doku… 
Bereiche¶
- Standards
- Setup mkdocs
- Erweiterungen
- Markdown
- Formatierungen / Beispiele
- Bilder einbinden
- Copy & Paste
- ToDo-Liste
- Notizen
- Wissen und FAQ
- Test
Standards¶
Hinweise zur Arbeit an der Dokumentation
Speicherort¶
Bilder im jeweiligen Unterverzeichnis /images
Globale Bilder wie Logo, Favicon etc. in /docs/assets/images
PDF Dateien zum Download in /docs/assets/download
Dateinamen¶
Kleinschreibung - Bindestrich - ohne Umlaute
Bildbenennung¶
Art - Bereich - Beschreibung - Nummer .Dateityp
grafik-poisuite-schema-01.svg
bild-poiapp-einrichtung-01.webp
screenshot-poiapp-poi-verifizieren-01.webp
Bilder¶
Bilder als .webp oder .svg
Bildgrösse max. 1920px
Bilder nicht in Tabelle einbetten (kein Umbruch)
Grid bei 2 Spalten (mit Bildern) verwenden
Anstatt 3-4 Bilder in eine Tabelle zu betten, bitte Content Tabs verwenden
Markierungen¶
==[TEXT]== (kurze Beschreibung) für Stellen an denen noch Inhalte ergänzt werden müssen.
==[BILD]== (kurze Beschreibung) für Stellen an denen noch Bilder ergänzt werden müssen.
Mit der Suche alle Stellen entsprechend anzeigen lassen…
Website: F und [TEXT] oder [BILD]
VS Code: Shift+Left Command+F und [TEXT] oder [BILD]
Bitte noch bearbeiten!¶
Hier einfach die erforderlichen Änderungen und Ergänzungen anzeigen lassen!
Entweder für die Live-Version (online) oder (local)
[online] Wo sind noch Änderungen notwendig?
[online] Wo müssen noch Bilder ergänzt werden?
[online] [Wo sind nochÄnderungen notwendig?](https://docs.thermaldrones.de/?q=%5Btext%5D)
[online] [Wo müssen noch Bilder ergänzt werden?](https://docs.thermaldrones.de/?q=%5Bbild%5D)
---
[local] [Wo sind noch Änderungen notwendig?](http://localhost:8000/team/?q=%5Btext%5D)
[local] [Wo müssen noch Bilder ergänzt werden?](http://localhost:8000/team/?q=%5Bbild%5D)