Skip to content
Snippets Groups Projects
Verified Commit c9647b16 authored by Jake's avatar Jake
Browse files

updated mdsyntax.de.md

parent 9c429a17
No related branches found
No related tags found
No related merge requests found
Pipeline #319725 passed
......@@ -39,22 +39,21 @@ beinhaltet sogar einen Zeilenumbruch.
## Überschriften
Überschriften werden genutzt um ein Dokument zu strukturieren.
Es gibt zwei Arten Überschriften zu schreiben: [Setext](#setext) und [ATX](#atx).
In Überschriften kann [Inlinemarkup](#inlinemarkup) verwendet werden.
Eine Leerzeile vor oder nach einer Überschrift ist nicht notwendig.
:::warning
Jede Seite wird automatisch mit einer Level 1 Überschrift aus dem Titel generiert.
Entsprechend sollten die meisten Dokumente nur Level 2-6 Überschriften verwenden!
:::
### Nutzungsinformationen
- Jede Seite wird automatisch mit einer Level 1 Überschrift aus dem Titel generiert.
Entsprechend sollten die meisten Dokumente nur Level 2-6 Überschriften verwenden!
- Überschriften haben semantische Bedeutung welche von Browsern, Bots und Screenreadern interpretiert und verwendet wird.
Überschriften sollten deshalb _niemals_ verwendet werden um Text einfach nur **fettgedruckt** oder in einer bestimmten Schriftgröße zu schreiben weil es ja "gut aussehen würde".
- Es sollte vermieden werden Überschriftenlevel zu überspringen. Siehe [hier](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements#navigation) für eine Erklärung.
:::warning
Überschriften haben semantische Bedeutung welche von Browsern, Bots und Screenreadern interpretiert und verwendet wird.
Überschriften sollten deshalb _niemals_ verwendet werden um Text einfach nur **fettgedruckt** oder in einer bestimmten Schriftgröße zu schreiben weil es ja "gut aussehen würde".
:::
### Setext
......@@ -101,6 +100,37 @@ Die Anzahl der `#`-Symbole am Anfang der Zeile gibt das Level an.
###### Eine Level 6 Überschrift
:::
### Identifikator, Attribute und Klassen
Am Ende der Zeile mit dem Überschriftentext kann man auch optionale Metadaten hinzugefügen.
Dafür schreibt man leerzeichengetrennt in geschweiften Klammern die folgenden Dinge:
- den Identifikator: `#Identifikator` (maximal einmal)
- die Klassen: `.eine-klasse .eine-andere-klasse .noch-eine-klasse`
- Die Klasse `.unnumbered` makiert eine Überschrift als "soll nicht nummeriert werden". Als Alias reicht auch ein `-`.
- Die Klasse `.unlisted` makiert eine Überschrfit als "soll im Inhaltsverzeichnis nicht eingetragen werden".
In den meisten Fällen wird maximal der Identifikator benötigt.
Der Identifaktor kann zum verlinken des entsprechenden Abschnittes verwendet werden.
```markdown
#### Eine Überschrift {#bspueberschrift}
#### Eine andere Überschrift {#anderebspueberschrift .mit-klassen .foobar}
#### Nich Nummeriert und nicht im Inhaltsverzeichnis {- .unlisted}
```
:::success
#### Eine Überschrift {#bspueberschrift}
#### Eine andere Überschrift {#anderebspueberschrift .mit-klassen .foobar}
#### Nich Nummeriert und nicht im Inhaltsverzeichnis {- .unlisted}
:::
:::info
Falls kein Identifikator für eine Überschrift gesetzt wurde, wird automatisch einer aus dem Überschriftentext generiert.
TODO
:::
:::danger
TODO continue https://pandoc.org/MANUAL.html#extension-header_attributes
:::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment