Markdown

Categories:

Markdown ist sicher die verbreiteteste einfache Ausschreibungssprache.

Syntax

Basic-Syntax

Hierbei handelt es sich um die Grundbefehle, die Markdown bietet und grundsätzlich in jedem Tool funktionieren sollten.

Überschriften

Um Überschriften darzustellen, wird dem Überschriftentitel ein oder mehrere Hashtags vorgesetzt. Je nach Ebene.

# Überschrift 1

## Überschrift 2

### Überschrift 3

#### Überschrift 4

##### Überschrift 5

###### Überschrift 6

Hinweis: Am besten immer eine Leerzeile vor einer Überschrift einfügen, da ohne die Interpretationen nicht korrekt sein kann.

Absätze/Zeilen

Für Zeilenschaltungen und Absätze gibt es keine wirklichen Notationen, sondern hier wird der Text wie geschrieben angezeigt. Als Unterstützung kann für eine Zeilenschaltung ein doppeltes Leerzeichen an das Ende der Zeile eingefügt werden, oder alternativ auch der HTML-Tag <br>.


Erste Zeile mit zwei Leerzeichen am Schluss.  
Und nun die nächste Zeile.

Erste Zeile mit dem HTML-Tag am Schluss.<br>
Und nun die nächste Zeile.

Textformatierung

Standardmässig bietet Markdown die Möglichkeit, Text als Fett und/oder Kurisv darzustellen.

Um einen Text fett darzustellen, wird der entsprechende Textteil zwischen doppelten Sternen oder Underscores geschrieben.


Bei mir gibt es auch **fetten Text**.

Bei mir gibt es auch __fetten Text__.

Und hier gibt es **fetten Text** in der Mitte.

Um einen Text kursiv darzustellen, wird der entsprechende Textteil zwischen einfachen Sternen oder Underscores geschrieben.


Bei mir gibt es auch *kursiven Text*.

Bei mir gibt es auch _kursiven Text_.

Und hier gibt es *kursiven Text* in der Mitte.

Natürlich lässt sich es sich auch kombinieren:

Um einen Text fett darzustellen, wird der entsprechende Textteil zwischen doppelten Sternen oder Underscores geschrieben.


Bei mir gibt es  ***fetten und kursiven Text***.

Bei mir gibt es auch ___fetten und kursiven Text___.

Und hier gibt es ***fetten und kursiven Text*** in der Mitte.

Blockzitate

Um einen Text als Block zu zitieren, wird einfach ein “Grösser als”-Zeichen vor die Zeile gesetzt.


> Dieser Text befindet sich in einem Blockzitat.

Wenn das Blockzitat mehrere Zeilen umfassen soll, muss am Anfang jeder Zeile (auch bei leeren Zeilen) das “Grösser als”-Zeichen gesetzt werden.


> Dieser Text stellt die erste Zeile im Blockzitat dar.
> 
> Und hier gibt es die nächste Zeile.

Zitate können auch ineinander verschachtelt werden, hier wird in der nächsten Ebene bzw. zur Einrückung ein weiteres “Grösser als”-Zeichen gesetzt.


> Dieser Text befindet sich in einem Blockzitat.
> 
>> Dieser Text ist in der Verschachtelung.

Listen

Listen sind genauso einfach und werden einfach im Text geschrieben. Geht es in der Liste in eine weitere Ebene, wird dies durch eine Einrückung (4 Leerzeichen bzw. 1 Tab) ermöglicht.

Sortierte Liste

Sortierte Listen werden generiert, in dem einfach die entsprechende Zahl inklusive einem Punkt vor die Zeile gesetzt wird.


1. Erster Punkt
2. Zweiter Punkt
3. Dritter Punkt
    1. erste Einrückung
    2. zweite Einrückung
4. Vierter Punkt
Unsortierte Liste

Unsortierte Listen werden generiert, in dem einfach ein Bindestich vor die Zeile gesetzt wird.


- Erster Punkt
- Zweiter Punkt
- Dritter Punkt
    - erste Einrückung
    - zweite Einrückung
- Vierter Punkt

Um einen Link darzustellen, wird der Linktext in eckige Klammer gesetzt, gefolgt von der URL innerhalb von Rundklammern.

Sortierte Listen werden generiert, in dem einfach die entsprechende Zahl inklusive einem Punkt vor die Zeile gesetzt wird.


Meine liebste Suchmaschine ist [Swisscows](https://swisscows.com/de).

```markdown

Dem Link kann auch ein zusätzlicher Titel als Tooltip hinzugefügt werden.

```markdown

Meine liebste Suchmaschine ist [Swisscows](https://swisscows.com/de "Die schweizer Suchmaschine").

Als Kurzform kann eine URL auch einfach innerhalb von Spitzklammern geschrieben werden.


Meine liebste Suchmaschine ist <https://swisscows.com/de>.

Erweiterte Syntax

Gerne! Hier ist der ergänzte Abschnitt „Erweiterte Syntax“ mit präzisen, kurzen Erklärungen zu den fehlenden Punkten – im gleichen Stil wie deine Doku:

Erweiterte Syntax

Tabellen

Tabellen werden mit senkrechten Strichen (|) und Bindestrichen (-) definiert. Die erste Zeile enthält die Spaltenüberschriften, die zweite Zeile definiert die Ausrichtung (optional).

| Links ausgerichtet | Zentriert       | Rechts ausgerichtet |
| :--------------- | :-------------: | ------------------: |
| Zelle 1          | Zelle 2         | Zelle 3             |
| Zelle 4          | Zelle 5         | Zelle 6             |

Hinweis: Die Anzahl der Bindestriche in der Trennzeile ist beliebig, wichtig ist nur das : für die Ausrichtung.

Code Blocks

Für mehrzeiligen Code wird ein Code Block mit drei Backticks (```) oder mit vier Leerzeichen pro Zeile erstellt. Optional kann die Sprache angegeben werden, um Syntax-Highlighting zu aktivieren.

```python
def hello():
    print("Hello, World!")


---

#### Fussnoten

Fussnoten werden mit `[^Kennung]` im Text eingefügt und am Ende der Datei mit `[^Kennung]:` definiert.

```markdown
Hier steht ein Text mit einer Fussnote.[^1]

[^1]: Das ist die Erklärung zur Fussnote.

Hinweis: Nicht alle Markdown-Parser unterstützen Fussnoten – z. B. Hugo benötigt goldmark mit aktivierter Option.

IDs für Überschriften

Überschriften können mit einer ID versehen werden, um sie direkt zu verlinken (z. B. für Inhaltsverzeichnisse oder Ankerlinks).

## Überschrift mit ID {#meine-id}

[Link zur Überschrift](#meine-id)

Hinweis: In Hugo muss enableInlineShortcodes = true in der Konfiguration aktiviert sein.

Aufgabenlisten

Aufgabenlisten (Checklisten) werden mit - [ ] für ungeprüfte und - [x] für geprüfte Items erstellt.

- [x] Aufgabe erledigt
- [ ] Noch zu erledigen
- [ ] Wird später gemacht

Hinweis: Wird oft in GitHub, GitLab oder Notiz-Apps wie Obsidian genutzt.

Durchgestrichen

Durchgestrichener Text wird mit doppelten Tilden (~~) umschlossen.

Dieser Text ist ~~durchgestrichen~~.

Emojis

Emojis können direkt eingefügt werden (z. B. 😊) oder mit Shortcodes wie :smile: (je nach Parser).

Ich bin heute gut gelaunt 😊

Hinweis: In Hugo müssen Emojis explizit aktiviert werden (enableEmoji = true).

Hervorheben von Text

Einige Parser (z. B. Hugo mit Goldmark) unterstützen Hervorhebungen mit ==:

Dieser Text ist ==hervorgehoben==.

Hinweis: Nicht standardisiert – funktioniert nicht überall.

Sub-/Superscript

Subscript (H₂O) und Superscript (x²) werden mit ~ bzw. ^ dargestellt – aber nur in einigen Erweiterungen wie Pandoc oder Hugo mit speziellem Parser.

Wasser ist H~2~O.  
x^2^ ist x hoch 2.

Hinweis: Nicht Teil des CommonMark-Standards – Funktioniert z. B. in Hugo mit goldmark und aktivierter Option.

Falls du möchtest, kann ich dir auch ein vollständiges, aktualisiertes Markdown-Referenzdokument im Hugo-Format als Download bereitstellen – sag einfach Bescheid!

Verwendung

Markdown stellt kein eigenes System dar, sondern steht rein für eine offene und frei verfügbare Syntax. Man könnte Markdown auch mit einer integrierbaren Scriptsprache vergleichen. Dies ist sicher auch der Grund, wieso so viele Systeme Markdown unterstützen und die Sprache dadurch so vielseitig verwendbar ist.

Wiki-Systeme

Wiki-Systeme wie z.B. Mediawiki (auf dem Wikipedia aufbaut), dokuWiki oder integrierte Wiki-Funktionen wie z.B. bei Github oder Gitlab setzen standardmässig auf Markdown zur Verwaltung der Inhalte.

Wikis sind ja vor allem dazu da, Inhalte zu präsentieren, im Git-Bereich Dokumentationen zur angebotenen Software. Dank der einfachen Syntax können diese auch von Nicht-Techies erstellt und verwaltet werden.

Notizen

Auch die vielfach verfügbaren Notiz-Apps (oder teilweise auch Desktop-Wikis genannt) greifen für die Verwaltung der Inhalte auf Markdown zurück. Oft wird ein integrierter WYSIWYG-Editor zur Verfügung gestellt, jedoch verwendet dieser im Hintergrund Markdown. Es gibt auch meist die Möglichkeit, auf den Quelltext umzustellen und dort direkt zu bearbeiten. Beispiele hierfür sind Zim, Zettlr, QOwnNotes und Logseq im Open-Source-Bereich oder populäre Varianten wie Evernote, Obsidian oder Joplin.

Webseiten

Im Bereich Webseiten kommt Markdown in zweierlei Hinsicht vor. Zum einen bieten die bekannten Content Management Systeme (wie z.B. Wordpress und Drupal) oft Plugins/Module, um Inhalte in Markdown zu veröffentlichen. Aber neben CMS gibt es auch SSG, sogenannte Static Site Generatoren, wie z.B. Hugo oder Jekyll. Dazu gibt es noch ähnliche auf technische Dokumentationen spezialisierte Systeme wie MKDocs, Sphinx oder Docusaurus. Auch hier werden die ganzen Inhalte in Markdown angelegt und dann mittels Preprocessor in statische Webseiten umgewandelt, die dann veröffentlicht werden können.

Präsentationen/Kurse

Neben Webseiten, können mit Markdown auch Präsentationen erstellt werden. Jedoch handelt es sich hier nicht um Powerpoint-Präsentationen, sondern werden diese mittels Preprocessoren dynamisch in Webelemente umgewandelt. Beispiele sind hierfür Marp, remarkJS oder Cleaver. Speziell für Online-Kurse bietet sich die Markdown-Erweiterung LiaScript an.

Dokumente

Markdown fehlen sicher einige Funktionalitäten, wie sie eine Textverarbeitung wie MS Word oder LibreOffice Writer vorweisen können, doch reicht es für einfache Dokumente wie z.B. Briefe vollkommen aus.

Fazit

Vorteile

Markdown hat eine einfache und klare Syntax, ist demzufolge leicht zu erlernen. Markdown-Dokumente haben auch den Vorteil, dass sie selbst im Quelltext leicht lesbar sind. Sie sind also sowohl maschinen- als auch menschenlesbar. Letzteres dank der einfachen und geradlinigen Syntax ohne Overhead. Auch die grosse Verbreitung von Markdown, der Integration in so viele Tools spricht für sich.

Nachteile

Neben den klaren Vorteilen, gibt es aber leider auch negatives über Markdown zu berichten.

Markdown eignet sich sehr gut für Artikel und Notizen, die nicht so komplex aufgebaut sind. Möchte man mehr und z.B. grosse und komplexe Dokumente erstellen, wie z.B. ganze Bücher, fehlen nützliche Funktionen wie Inhaltsverzeichnis oder die Möglichkeit, Dateien mittels “Include” zu verschachteln.

Zwar gibt es mit CommonMark einen Markdown-Standard, doch die starke Verbreitung hat doch zu vielen “Dialekten” geführt, da viele Tools die Standard-Syntax durch eigene Befehle erweitern. Dadurch sind Markdown-Dokumente aus verschiedenen Systemen nicht zwingend untereinander kompatibel.

Weiterführende Informationen

Literatur

Tools zur Anwendung von Markdown

Desktop-Wikis

Texteditoren

Static Site Generatoren

Transformations-Werkzeuge