1.5 KiB
1.5 KiB
kind, section
| kind | section |
|---|---|
| explain | policy |
Formatierung
Alle Dokumente müssen nach diesen Regeln formatiert werden:
Vor und nach jeder Liste ein Absatz
🟥
Meine Liste:
- a
- b
- c
Und hier geht es weiter:
✅
Meine Liste:
- a
- b
- c
Und hier geht es weiter:
Nach jeder Überschrift ein Absatz
🟥
## Überschrift 2
Mehr Text.
✅
## Überschrift 2
Mehr Text.
Code-Fences mit Typen
🟥
~~~
x = 1
~~~
✅
```python
x = 1
```
Dateinamen als Code
🟥
Copy the file 'autoinstall.yaml'.
✅
Copy the file `autoinstall.yaml`.
Urls einklammern
🟥
Letzte Version von Ubuntu Desktop von www.ubuntu.com
✅
Letzte Version von Ubuntu Desktop von <www.ubuntu.com>
Kursiv statt Hochkomma
🟥
Drücken Sie auf den Knopf "Installieren".
✅
Drücken Sie auf den Knopf _Installieren_.
Listen immer mit Dashes
🟥
Meine Liste:
* a
* b
* c
✅
Meine Liste:
- a
- b
- c
Klare Pfadangaben
🟥
Navigiere nach "Einstellungen>Technisch>Datenbank".
✅
Navigiere nach _Einstellungen > Technisch > Datenbank_.
Metadaten festlegen
Alle Einträge brauchen Metadaten:
---
kind: explain
section: policy
---
# Titel
...
Mindestens kind und section müssen gesetzt sein.