Der umfassendste Markdown-Spickzettel online
Der umfassendste Markdown-Spickzettel online. Jedes Syntaxelement mit Beispielen, gerenderter Ausgabe, Plattformkompatibilität, häufigen Fehlern und Expertentipps. Setzen Sie ein Lesezeichen darauf.
Markdown ist eine einfache Möglichkeit, Text mit Symbolen wie Hashtags, Sternchen und Klammern zu formatieren. Es ist nützlich für Autoren, Blogger, Entwickler, Studenten und alle, die Inhalte online erstellen, da es die Formatierung schnell, sauber und einfach auf verschiedenen Plattformen wiederverwendbar macht. Dieses Markdown-Cheatsheet zeigt Ihnen die gängigsten Regeln, damit Sie von nun an in Markdown schreiben und veröffentlichen können.
Was ist Markdown?
Markdown ist eine leichte Auszeichnungssprache, die es Ihnen ermöglicht, Klartextsymbole zum Formatieren von Dokumenten zu verwenden. Wenn Sie „bold“ eingeben, werden Sie fett angezeigt. Wenn Sie „# Überschrift“ eingeben, wird daraus eine Überschrift. Wenn Sie Markdown verwenden, wird es in HTML konvertiert. Es funktioniert auf praktisch jeder Plattform und ist zur Standardsprache für die Formatierung auf Tausenden von Tools, Plattformen und Websites geworden, darunter GitHub, Reddit, Discord, Notion, Slack und Obsidian.
Warum Markdown wichtig ist
John Gruber gründete Markdown im Jahr 2004 mit dem Ziel, es Menschen zu ermöglichen, Dokumente mit einfachem Text zu schreiben und zu formatieren, ohne auf ein Durcheinander von Tags achten zu müssen. Heute hat sich Markdown zu einer Sprache entwickelt, die von praktisch jedem Entwickler und Builder sowie von Content-Autoren und anderen verwendet wird.
Die Vorteile von Markdown
Markdown ist so beliebt, weil es viele Probleme löst, die bei früheren Formaten ein Problem waren.
- Markdown funktioniert überall und wird es immer tun: Sie können eine „.md“-Datei in jedem Texteditor und auf jedem Betriebssystem öffnen, und Sie werden sie auch in 50 Jahren öffnen können.
- Sie können Markdown lesen, ohne es zu rendern: Im Gegensatz zu RTF oder HTML ist Markdown ein Format, das in seiner Rohform lesbar ist, nicht erst nach dem Rendern.
- Mit Markdown lässt sich schnell arbeiten: Erfahrene Autoren können Text während der Eingabe formatieren und schneller arbeiten.
- Markdown ist universell: Wie bereits erwähnt, verwenden viele Plattformen Markdown nativ.
Heutzutage ist Markdown für jeden, der etwas mit KI-Tools erstellt, wichtig zu wissen, da LLMs standardmäßig Markdown ausgeben.
Grundlegende Markdown-Syntax
Diese Elemente stammen aus der ursprünglichen Spezifikation von John Gruber aus dem Jahr 2004. Jeder Markdown-Parser unterstützt sie, mit geringfügigen Implementierungsunterschieden, die unten aufgeführt sind.
Kurzreferenztabelle
| Element | Markdown-Syntax |
|---|---|
| Markdown-Überschrift | # H1 ## H2 ### H3 |
| Markdown Fett | „bold“ oder „bold“ |
| Markdown Kursiv | *kursiv* oder _kursiv_ |
| Markdown Fett + Kursiv | ***fett kursiv*** |
| Markdown-Blockquote | > zitierter Text |
| Markdown-geordnete Liste | „1. Artikel` |
| Ungeordnete Markdown-Liste | „- Item“ oder „* Item“ oder „+ Item“ |
| Markdown-Inline-Code | `Code` |
| Markdown-Codeblock | 4 Leerzeichen einrücken oder eingezäunte Blöcke verwenden |
| Horizontale Markdown-Regel | --- oder *** oder ___ |
| Markdown-Link | [text](https://example.com) |
| Markdown-Bild |  |
| Markdown-Zeilenumbruch | Beenden Sie eine Zeile mit zwei abschließenden Leerzeichen |
Markdown-Überschriften
Verwenden Sie 1–6-Pfund-Zeichen („#“), gefolgt von einem Leerzeichen. Die Anzahl der Zeichen entspricht der HTML-Überschriftenebene.
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Alternative Syntax (Setext-Stil) funktioniert nur für H1 und H2:
Heading 1
=========
Heading 2
---------
Best Practices:
- Setzen Sie immer ein Leerzeichen zwischen „#“ und dem Überschriftentext. „#Heading“ funktioniert bei einigen Parsern, führt jedoch bei anderen zu Unterbrechungen.
- Verwenden Sie nur ein H1 pro Dokument (normalerweise den Seitentitel).
- Überspringen Sie keine Überschriftenebenen. Gehen Sie zu H1 → H2 → H3, nicht zu H1 → H3.
- Fügen Sie für maximale Kompatibilität Leerzeilen vor und nach Überschriften hinzu.
Markdown Fett, Kursiv und Hervorhebung
**This is bold** and __this is also bold__
*This is italic* and _this is also italic_
***Bold and italic*** combined
Wird gerendert als:
Das ist fett und das ist auch fett Das ist kursiv und das ist auch kursiv Fett und Kursiv kombiniert
Verstanden: Einige Parser verarbeiten keine Unterstriche in der Mitte eines Wortes. Für maximale Kompatibilität verwenden Sie Sternchen zur Betonung der Wortmitte: „un**believ__able“, nicht „un__believ__able“.
Markdown-Blockzitate
Beginnen Sie eine beliebige Zeile mit „>“, um ein [Markdown-Blockquote] (/blog/markdown-blockquotes-guide) zu erstellen.
> This is a single-line blockquote.
> This is a blockquote
> that spans multiple lines.
> Blockquotes can be nested.
>
> > Like this.
>
> And they can contain **other markdown** elements.
Markdown-Blockzitate eignen sich gut zum Hervorheben von Anführungszeichen, Hinweisen und Formatierungen im Antwortstil in E-Mails.
Markdown-Listen
Ungeordnete Listen akzeptieren austauschbar „-“, „*“ oder „+“. Wählen Sie einen Stil und bleiben Sie dabei, um Konsistenz zu gewährleisten.
- First item
- Second item
- Third item
- Nested item (indent two or four spaces)
- Another nested item
- Fourth item
Geordnete Listen verwenden Zahlen gefolgt von einem Punkt:
1. First item
2. Second item
3. Third item
Nützlicher Trick: Die Zahlen müssen nicht korrekt sein. Markdown wird automatisch neu nummeriert:
1. First
1. Second
1. Third
…wird identisch gerendert wie „1, 2, 3“. Dies bedeutet, dass Sie Artikel nachbestellen können, ohne sie neu zu nummerieren.
Verschachtelung geordneter und ungeordneter Markdown-Listen:
1. First step
2. Second step
- Sub-bullet
- Another sub-bullet
3. Third step
1. Sub-step
2. Another sub-step
Elemente mit mehreren Absätzen auflisten: Die Fortsetzung um die gleiche Anzahl Leerzeichen einrücken (normalerweise 4 oder einen Tabulator):
1. First item
This paragraph belongs to the first item.
Notice the blank line above and the indent.
2. Second item
Markdown-Links
Inline-Links sind der gebräuchlichste Stil:
[Visit Google](https://www.google.com)
[With hover title](https://www.google.com "Google's homepage")
Markdown-Links im Referenzstil sind nützlich, wenn dieselbe URL mehrmals vorkommt oder wenn Sie den Text sauber halten möchten:
I love [Obsidian][1] and [VS Code][vscode] for markdown.
[1]: https://obsidian.md
[vscode]: https://code.visualstudio.com
Automatische URLs. Setzen Sie eine leere URL in spitze Klammern:
<https://example.com>
<hello@example.com>
Relative Links. Link zu Dateien im selben Repository oder Ordner:
[Read the license](./LICENSE.md)
[Parent directory file](../README.md)
Markdown-Ankerlinks. Springe zu einer Überschrift auf derselben Seite. Die meisten Parser generieren automatisch IDs aus dem Überschriftentext (Kleinbuchstaben, Leerzeichen bis Bindestriche):
Jump to [the installation section](#installation).
## Installation
Markdown-Bilder
Die Markdown-Bildsyntax ist die Link-Syntax mit einem führenden Ausrufezeichen:
Markdown-Bilder im Referenzstil funktionieren auf die gleiche Weise wie Referenzlinks:
![Company logo][logo]
[logo]: /images/logo.png "Our logo"
Aus einem Markdown-Bild einen Link machen:
[](https://example.com)
Größenanpassung von Bildern. Reines Markdown hat hierfür keine Syntax. Verwenden Sie Inline-HTML als Fallback:
<img src="image.jpg" alt="Alt text" width="400">
Hinweis zur Barrierefreiheit: Schreiben Sie immer aussagekräftigen Alternativtext. Screenreader sind darauf angewiesen und Suchmaschinen nutzen es, um Bildinhalte zu verstehen.  ist schlecht; „
“ ist gut.
Markdown-Code
Markdown-Inline-Code umschließt einzelne Backticks:
Install with `npm install markdown-it`.
Markdown-Codeblöcke. Jede Zeile um vier Leerzeichen (oder einen Tabulator) einrücken:
function hello() {
console.log("Hello, world!");
}
In der Praxis verwendet fast jeder stattdessen abgeschirmte Codeblöcke (siehe Abschnitt zur erweiterten Syntax weiter unten), da diese die Syntaxhervorhebung unterstützen.
Backticks innerhalb des Inline-Codes maskieren. Mehr Backticks außen verwenden:
To show a backtick, use `` `backtick` `` like this.
Horizontale Markdown-Regeln
Drei oder mehr Bindestriche, Sternchen oder Unterstriche in einer eigenen Zeile:
---
***
___
Alle drei werden identisch gerendert. Fügen Sie aus Kompatibilitätsgründen Leerzeilen davor und danach ein.
Markdown-Zeilenumbrüche
Dies ist eine der verwirrendsten Funktionen von Markdown. Es gibt drei verschiedene Verhaltensweisen:
Absatzumbruch. Lassen Sie eine Leerzeile zwischen dem Text:
This is paragraph one.
This is paragraph two.
Fester Zeilenumbruch (gleicher Absatz). Beenden Sie eine Zeile mit zwei Leerzeichen am Ende:
This line ends with two spaces.␣␣
This line is a break within the same paragraph.
HTML-Fallback. Verwenden Sie „
“, wenn nachfolgende Leerzeichen zu fragil erscheinen:
This line has an HTML break.<br>
This is the next line.
Warum nachgestellte Leerzeichen umstritten sind: Sie sind unsichtbar. Die meisten Editoren entfernen sie beim Speichern. GitHub Flavored Markdown (GFM) löst dieses Problem, indem jede einzelne neue Zeile als Zeilenumbruch innerhalb eines Absatzes behandelt wird, Standard-CommonMark erfordert jedoch die nachgestellten Leerzeichen.
Markdown-Escape-Zeichen
Um ein Zeichen anzuzeigen, das Markdown normalerweise als Formatierung interpretieren würde, stellen Sie ihm einen Backslash voran:
\*This shows literal asterisks\*
\# This shows a literal hash sign
\[not a link\]
Escape-Zeichen: \ ` * _ {} [] () # + - . ! |
Erweiterte Markdown-Syntax
Diese Elemente sind nicht in der ursprünglichen Spezifikation von Gruber enthalten, werden aber von den meisten gängigen Markdown-Prozessoren unterstützt, darunter GitHub, GitLab, Reddit, Stack Overflow, Obsidian, Notion und Discord. Die Kompatibilität ist unterschiedlich. Überprüfen Sie daher die nachstehende Matrix, bevor Sie sich auf eines davon verlassen.
Kurzreferenztabelle
| Element | Markdown-Syntax |
|---|---|
| Markdown-Tabelle | | Kopfzeile | Kopfzeile | + | --- | --- | |
| Abgegrenzter Markdown-Codeblock | ```Sprache ...``` |
| Markdown-Syntax-Highlight | Sprachname nach dem Öffnen des Zauns |
| Markdown-Fußnote | Hier ist eine Notiz.[^1] ... [^1]: Notiztext. |
| Markdown-Überschriften-ID | ### Meine Überschrift {#custom-id} |
| Markdown-Definitionsliste | term newline : definition |
| Markdown durchgestrichen | ~~gelöschter Text~~ |
| Markdown-Aufgabenliste | - [x] Fertig - [ ] Todo |
| Markdown-Emoji-Shortcode | :joy: :rocket: |
| Markdown-Highlight | ==highlighted== |
| Markdown-Index | „H |
| Markdown hochgestellt | E = mc^2^ |
| Automatische Markdown-URL | <https://example.com> |
| GitHub-Markdown-Warnungen | > [!NOTE] > [!WARNING] > [!TIP] |
Markdown-Tabellen
Verwenden Sie Pipes (|) für Spalten und eine Reihe von Bindestrichen für das Kopftrennzeichen.
| Name | Role | Location |
| -------- | ---------- | ------------- |
| Alice | Developer | Berlin |
| Bob | Designer | Montreal |
| Carol | Writer | Sydney |
Spaltenausrichtung. Doppelpunkte zur Trennzeile hinzufügen:
| Left-aligned | Centered | Right-aligned |
| :----------- | :----------: | ------------: |
| apples | bananas | $100 |
| cherries | dates | $12 |
Tipps, die die meisten Reiseführer übersehen:
- Sie müssen die Rohre in Ihrer Quelle nicht ausrichten. Der Renderer übernimmt die Abstände. – Die äußeren Pipes sind optional, aber das Hinzufügen hilft bei der Lesbarkeit und den Editor-Plugins.
- Sie können grundlegende Markdowns innerhalb von Zellen verwenden („fett“, „kursiv“, „Code“, Links).
- Sie können keine Blockelemente (Überschriften, Anführungszeichen, Listen) innerhalb von Zellen verwenden.
- Für mehrzeiligen Inhalt innerhalb einer Zelle verwenden Sie „
“ anstelle eines Zeilenumbruchs. - Um ein literales Pipe-Zeichen innerhalb einer Zelle anzuzeigen, verwenden Sie die HTML-Entität „|“.
Abgegrenzte Markdown-Codeblöcke
Drei Backticks (oder Tilden) öffnen und schließen einen Block. Fügen Sie nach dem Eröffnungszaun eine Sprachkennung zur Syntaxhervorhebung hinzu:
```Python
auf jeden Fall grüßen(Name):
return f"Hallo, {Name}!"
print(greet("world"))```
Gemeinsame Sprachkennungen: „Python“, „Javascript“, „Typescript“, „Bash“, „Shell“, „SQL“, „Json“, „Yaml“, „HTML“, „CSS“, „Rust“, „Go“, „Java“, „C“, „CPP“, „CSharp“, „PHP“, „Ruby“, „swift“, „kotlin“, „dart“, „r“, „scala“, „diff“.
Codeänderungen mit diff: anzeigen
```diff
- const old = "entferne dies";
+ const new = "füge dies hinzu";```
Entkommen von dreifachen Backticks. Wickeln Sie den Block in vier Backticks ein:
````
Dieser Block enthält```triple backticks```innen.````
```„
### Markdown-Fußnoten
Markdown-Fußnoten eignen sich perfekt für Zitate, Nebenbemerkungen und erläuternde Anmerkungen, ohne Ihre Prosa zu überladen.
```markdown
Here is a statement that needs a source.[^1]
Here is another claim.[^detailed-note]
[^1]: This is a short footnote.
[^detailed-note]: Named footnotes still render as numbers, but they're
easier to track in the source. They can span multiple lines if you
indent the continuation.
```
### Markdown-Überschriften-IDs
Bei einigen Parsern können Sie Überschriften benutzerdefinierte IDs zuweisen, um eine präzise Ankerverknüpfung zu ermöglichen:
```markdown
### My Great Heading {#custom-heading-id}
Jump to [my heading](#custom-heading-id).
```
GitHub und viele andere generieren automatisch IDs aus dem Überschriftentext, sodass Sie dies normalerweise nicht benötigen.
### Markdown-Definitionslisten
```markdown
Markdown
: A lightweight markup language for formatting plain text.
HTML
: The standard markup language for web pages.
CSS
: The language used to style HTML documents.
```
Der Support ist lückenhaft. Es funktioniert in Pandoc, PHP Markdown Extra und einigen anderen, aber nicht im Standard-GFM.
### Markdown durchgestrichen
Wickeln Sie den Text in zwei Tilden ein, um ihn durchzustreichen:
```markdown
~~This text is struck through.~~
```
**Dargestellt als:** ~~Dieser Text ist durchgestrichen.~~
Funktioniert in GFM, Reddit, Discord, Slack und den gängigsten Prozessoren. Nicht im Standard-CommonMark.
### Markdown-Aufgabenlisten
Interaktive Kontrollkästchen, die häufig in GitHub-Problemen, Pull-Requests und Projektboards verwendet werden:
```markdown
- [x] Write the first draft
- [x] Edit for clarity
- [ ] Publish the article
- [ ] Promote on social media
- [ ] Twitter
- [ ] LinkedIn
- [ ] Hacker News
```
Auf GitHub werden diese als anklickbare Kontrollkästchen dargestellt, die Sie direkt in der Benutzeroberfläche umschalten können.
### Markdown-Emoji
Die meisten Plattformen unterstützen Emoji-Shortcodes:
```markdown
Ship it :rocket: and celebrate :tada::champagne:
```
Sie können auch echte Emoji-Zeichen direkt einfügen. Sie werden in jeder Markdown-Datei problemlos gerendert, da es sich lediglich um Unicode handelt. 🚀🎉
### Markdown Hervorhebung, Tiefstellung, Hochstellung
```markdown
I need to ==highlight== this important idea.
Water is H~2~O.
Einstein's famous equation: E = mc^2^.
```
Der Support ist begrenzt. Funktioniert in Obsidian, MultiMarkdown und einigen erweiterten Parsern, jedoch nicht in GFM.
### Markdown Automatische URL-Verknüpfung
Schließen Sie eine URL in spitze Klammern ein, um einen automatischen Link zu erstellen:
```markdown
<https://example.com>
<contact@example.com>
```
In GitHub Flavored Markdown wird jede bloße URL automatisch konvertiert. Sie benötigen nicht einmal die Klammern.
---
## Plattformkompatibilitätsmatrix
Überprüfen Sie anhand dieser Tabelle, welche Syntaxelemente auf den von Ihnen verwendeten Plattformen funktionieren. „Ja“ bedeutet volle Unterstützung, „Nein“ bedeutet keine Unterstützung und „Teilweise“ bedeutet, dass die Funktion mit Einschränkungen funktioniert oder eine nicht standardmäßige Syntax verwendet.
| Funktion | GFM | GitLab | Reddit | Zwietracht | Locker | Vorstellung | Obsidian | Stapelüberlauf |
| ----------------- | :-----: | :-----: | :-----: | :-----: | :-----: | :-----: | :------: | :------------: |
| Überschriften | Ja | Ja | Ja | Nein | Nein | Ja | Ja | Ja |
| Fett / Kursiv | Ja | Ja | Ja | Ja | Teilweise\* | Ja | Ja | Ja |
| Durchgestrichen | Ja | Ja | Ja | Ja | Ja | Ja | Ja | Ja |
| Blockzitat | Ja | Ja | Ja | Ja | Ja | Ja | Ja | Ja |
| Listen | Ja | Ja | Ja | Ja | Ja | Ja | Ja | Ja |
| Inline-Code | Ja | Ja | Ja | Ja | Ja | Ja | Ja | Ja |
| Eingezäunter Code | Ja | Ja | Ja | Ja | Ja | Ja | Ja | Ja |
| Syntax-Highlight | Ja | Ja | Teilweise | Teilweise | Nein | Ja | Ja | Ja || Links | Ja | Ja | Ja | Ja | Teilweise\*\* | Ja | Ja | Ja |
| Bilder | Ja | Ja | Teilweise | Teilweise | Teilweise | Ja | Ja | Ja |
| Tabellen | Ja | Ja | Ja | Nein | Nein | Ja | Ja | Ja |
| Aufgabenlisten | Ja | Ja | Nein | Nein | Nein | Ja | Ja | Nein |
| Fußnoten | Ja | Ja | Nein | Nein | Nein | Nein | Ja | Nein |
| Emoji-Shortcodes | Ja | Ja | Nein | Ja | Ja | Nein | Teilweise | Nein |
| Mathematik (LaTeX) | Ja | Ja | Nein | Nein | Nein | Ja | Ja | Ja |
| Meerjungfrau-Diagramme | Ja | Ja | Nein | Nein | Nein | Nein | Ja | Nein |
| Unterstreichen | Nein | Nein | Nein | Ja | Nein | Ja | Teilweise | Nein |
| Spoilertext | Nein | Nein | Ja | Ja | Nein | Nein | Nein | Nein |
**\*** Slack verwendet einzelne Sternchen für Fettschrift (nicht doppelt) und einzelne Unterstriche für Kursivschrift.
**\*\*** Slack verwendet die Syntax „<url|text>“ anstelle von Standard-Markdown-Links.
---
## Markdown mit GitHub-Geschmack
GitHub Flavored Markdown (GFM) ist der einflussreichste Markdown-Dialekt. Da GitHub die Standard-Homepage für Open-Source-Projekte ist, sind GFM-Konventionen zum De-facto-Standard geworden.
GFM fügt zusätzlich zum Standardabschlag Folgendes hinzu:
### GitHub-Benachrichtigungen
Eine spezielle Blockquote-Syntax für Callouts. Es werden fünf Typen unterstützt:
```markdown
> [!NOTE]
> Useful information that users should know.
> [!TIP]
> Helpful advice for doing things better.
> [!IMPORTANT]
> Key information users need to know.
> [!WARNING]
> Urgent info needing immediate attention.
> [!CAUTION]
> Advises about risks or negative outcomes.
```
Jedes wird mit einer eigenen Farbe und einem bestimmten Symbol auf GitHub gerendert.
### Markdown-Autolink-Referenzen
In GitHub-Repos werden bestimmte Muster automatisch zu Links:
- „#123“ → Links zum Issue oder Pull Request Nr. 123
- „@Benutzername“ → erwähnt einen Benutzer
- `org/repo#123` → Links zu einem Problem in einem anderen Repo
- „a1b2c3d“ → Links zu einem Commit-Hash
### Markdown Meerjungfrau-Diagramme
Eingezäunte Codeblöcke mit „Mermaid“ als Sprache werden als Flussdiagramme, Sequenzdiagramme und mehr dargestellt:
````markdown
```Meerjungfrau
Grafik LR
A[Start] -> B{Entscheidung}
B -->|Ja| C[Mach das Ding]
B -->|Nein| D[Überspringen]```
````
### Mathematische Ausdrücke markieren
GFM unterstützt LaTeX-Mathematik in zwei Formen:
```markdown
Inline math: $E = mc^2$
Block math:
$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$
```
---
## Plattformspezifischer Markdown
### Discord-Markdown
Discord verwendet eine eigene Markdown-Variante. Hauptunterschiede zum Standard:
- „__underline__“ (doppelte Unterstriche) erzeugt Unterstreichungen, nicht Fettdruck
- „**fett**“ funktioniert immer noch
- „*italic*“ und „_italic_“ funktionieren beide
- `||spoiler||` verbirgt Text, bis darauf geklickt wird
- „# Heading“ funktioniert, aber nur H1, H2 und H3 werden unterstützt
- Codeblöcke und Inline-Code funktionieren normal
- Keine Tabellen, keine Bilder über Markdown-Syntax
### Slack-Markdown (mrkdwn)
Die Markdown-Variante von Slack, die verwirrenderweise „mrkdwn“ genannt wird, weicht deutlich voneinander ab:
- „*fett*“ verwendet einzelne Sternchen (nicht doppelt)
- „_italic_“ verwendet einzelne Unterstriche
- „~strikethrough~“ verwendet einzelne Tilden
- „Code“ funktioniert normal
- `>quote` funktioniert normal
- Links verwenden die Syntax „<https://example.com|link text>“.
- Keine Überschriften, keine Tabellen, keine Aufgabenlisten
Wenn Sie Standard-Markdown in Slack einfügen, wird es nicht richtig formatiert. Zuerst konvertieren.
### Reddit-Markdown
Reddit unterstützt die meisten Standard- und erweiterten Syntaxen mit ein paar Besonderheiten:
- `>!spoiler!<` für Spoilertext
- „^hochgestellt“ mit einem Caret (für einzelne Wörter ist kein schließendes Caret erforderlich)
- Unterstützt Tabellen, Durchstreichungen und Codeblöcke
– Unterstützt keine Aufgabenlisten, Fußnoten oder benutzerdefinierten Überschriften-IDs
### Begriffsabschlag
Notion unterstützt die Markdown-Eingabe, konvertiert sie jedoch in sein Blocksystem. Sie können Markdown eingeben, um Blöcke schnell zu erstellen:
- Standard-Markdown funktioniert während der Eingabe
– Notion fügt seine eigenen Funktionen (Datenbanken, Umschalter, Beschriftungen) hinzu, die kein Standard-Markdown sind
- Das Einfügen von Markdown-Inhalten führt im Allgemeinen zu einem sauberen Import
### Obsidian-Markdown
Obsidian ist eine Notizen-App, die Markdown verwendet, mit mehreren Erweiterungen:
- „[[Links im Wiki-Stil]]“ für interne Links zwischen Notizen
- „[[Notiz#Überschrift]]“, um auf eine bestimmte Überschrift in einer anderen Notiz zu verweisen
- „![[Note]]“, um den Inhalt einer anderen Notiz einzubetten
- „> [!note] Callout-Titel“ für Obsidian-Callouts (ähnlich den GitHub-Benachrichtigungen)
- Vollständige LaTeX-Mathe-Unterstützung
- Volle Mermaid-Unterstützung
---
## Häufige Markdown-Fehler
Sogar erfahrene Autoren machen diese Abschriftenfehler. Hier erfahren Sie, was Sie vermeiden sollten und wie.
### 1. Fehlende Leerzeilen um Markdown-Blockelemente
Listen, Überschriften, Codeblöcke und Blockzitate benötigen normalerweise eine Leerzeile davor und danach. Ohne sie werden sie von einigen Parsern in den umgebenden Absatz eingefügt.
**Falsch:**```markdown
Here is a paragraph.
## Heading
More text.
```
**Rechts:**```markdown
Here is a paragraph.
## Heading
More text.
```
### 2. Inkonsistente Einrückung der Markdown-Liste
Verschachtelte Listen benötigen eine konsistente Einrückung. Das Mischen von Einzügen mit zwei und vier Leerzeichen oder das Mischen von Tabulatoren und Leerzeichen führt zu unvorhersehbaren Ergebnissen. Wählen Sie eine aus und bleiben Sie dabei.
### 3. Nachgestellte Leerzeichen für Markdown-Zeilenumbrüche vergessen
Wenn Sie einen Zeilenumbruch innerhalb eines Absatzes wünschen, Ihr Text aber zusammenläuft, haben Sie wahrscheinlich die beiden Leerzeichen am Ende vergessen. Dies ist die häufigste Markdown-Frage bei Stack Overflow.
### 4. Relative Markdown-Bildpfade brechen nach der Bereitstellung ab
„“ funktioniert in Ihrem Editor, funktioniert jedoch nicht, wenn es in einem Unterverzeichnis bereitgestellt wird. Verwenden Sie zur Portabilität Site-absolute Pfade („/images/logo.png“) oder vollständig qualifizierte URLs.
### 5. Verwendung intelligenter Anführungszeichen im Word-Stil in Markdown-Codeblöcken
Wenn Sie Code aus einem Dokument einfügen, das geschweifte Anführungszeichen enthält („““ anstelle von „““), funktioniert der Code beim Kopieren nicht. Fügen Sie Code immer als Klartext in Markdown-Dateien ein.
### 6. HTML und Markdown innerhalb desselben Blocks mischen
Markdown innerhalb von HTML-Tags auf Blockebene wird oft nicht gerendert. Dies schlägt fehl:
```markdown
<div>
**This bold won't render.**
</div>
```
Beheben Sie das Problem, indem Sie sie durch Leerzeilen trennen oder nur Inline-HTML verwenden:
```markdown
<div>
**This bold will render.**
</div>
```
### 7. Markdown-Überschriftenebenen überspringen
Der direkte Übergang von H1 zu H3 verringert die Zugänglichkeit und schadet der Suchmaschinenoptimierung. Verwenden Sie die Überschriftenebenen nacheinander.
### 8. Verwendung von Unterstrichen innerhalb von Wörtern im Markdown
„un_believ_able“ erzeugt in einigen Parsern Kursivschrift und in anderen wörtliche Unterstriche. Verwenden Sie Sternchen zur Betonung der Wortmitte: „un*glaublich*bar“.
---
## Häufig gestellte Fragen zu Markdown
### Wofür wird der Abschlag verwendet?
Markdown wird für Dokumentation (READMEs, API-Dokumente, Wikis), Blog-Beiträge, technisches Schreiben, Notizen, Chat-Nachrichten auf Plattformen wie Discord und Slack, statische Websites, E-Books und überall dort verwendet, wo eine Nur-Text-Formatierung nützlich ist. Die meisten großen Sprachmodelle geben Antworten standardmäßig im Markdown aus.
### Ist der Markdown auf jeder Plattform gleich?
Nein. Die grundlegende Syntax (Überschriften, Hervorhebung, Listen, Links, Code, Anführungszeichen) funktioniert fast überall, aber erweiterte Funktionen wie Tabellen, Fußnoten, Aufgabenlisten und Mathematik variieren erheblich zwischen den Plattformen. Weitere Informationen finden Sie in der Kompatibilitätsmatrix oben.
### Welche Dateierweiterung verwendet Markdown?
„.md“ ist am häufigsten. Möglicherweise sehen Sie auch „.markdown“, „.mdown“, „.mkd“ oder „.mkdn“. Sie haben alle das gleiche Format. Der MIME-Typ ist „text/markdown“, registriert in RFC 7763.
### Kann ich HTML innerhalb von Markdown verwenden?
Ja. Nahezu jeder Markdown-Prozessor leitet Roh-HTML an die Ausgabe weiter. Auf diese Weise fügen Benutzer Funktionen hinzu, die von Markdown nicht nativ unterstützt werden, z. B. „<kbd>“-Tags für Tastaturtasten, „<details>“ für reduzierbare Abschnitte, „<iframe>“ für Einbettungen und mehr.
### Wie konvertiere ich Markdown in PDF, Word oder HTML?
**Zu HTML:** Jeder Markdown-Prozessor erledigt dies nativ. Pandoc, Markdown-it und Marked sind beliebte Bibliotheken.
**Zu PDF:** Verwenden Sie Pandoc („pandoc input.md -o output.pdf“), die Exportfunktion von Typora oder VS Code mit der Markdown-PDF-Erweiterung.
**Zu Word (.docx):** Pandoc erledigt dies sauber mit „pandoc input.md -o output.docx“.
### Unterstützt Markdown mathematische Gleichungen?
Nicht in der Originalspezifikation, aber viele Prozessoren (GitHub, GitLab, Obsidian, MkDocs, Jupyter, Notion) unterstützen LaTeX-Mathematik. Verwenden Sie „$...$“ für Inline-Mathematik und „$$...$$“ für Blockgleichungen.
### Wie unterscheidet sich Markdown von HTML?
HTML verwendet Tags („<p>“, „<strong>“, „<a>“), die ausführlich, aber präzise sind. Markdown verwendet Satzzeichen, die schnell eingegeben werden können und auch im Klartext lesbar bleiben. Jede Markdown-Datei wird letztendlich zur Anzeige in HTML konvertiert. Markdown ist eine Obermenge von HTML. Sie können HTML jederzeit in eine Markdown-Datei einfügen, wenn Sie etwas benötigen, das Markdown nicht ausdrücken kann.
### Was ist CommonMark?
CommonMark ist eine standardisierte Spezifikation für Markdown, die 2014 veröffentlicht wurde, um Unklarheiten in Grubers Originalspezifikation zu beseitigen. Die meisten Prozessoren implementieren CommonMark als Basis und fügen dann Erweiterungen (Tabellen, Aufgabenlisten usw.) hinzu. GitHub Flavored Markdown ist CommonMark plus GitHubs Erweiterungen.
### Ist der Preisnachlass kostenlos?
Ja. Markdown ist keine Software. Es ist eine Spezifikation. Sowohl die ursprüngliche Gruber-Spezifikation als auch die CommonMark-Spezifikation sind frei verfügbar. Der Name „Markdown“ selbst ist nicht markenrechtlich geschützt.
### Wie lange dauert es, Markdown zu lernen?
Die Grundlagen (Überschriften, Fett, Kursiv, Links, Listen) dauern etwa fünf Minuten. Sie können innerhalb einer Stunde einen nützlichen Abschlag schreiben. Die Beherrschung erweiterter Syntax und plattformspezifischer Variationen dauert länger, aber dieser Spickzettel deckt fast alles ab, was Sie jemals brauchen werden.
### Was ist der Unterschied zwischen Markdown und Rich Text?
Rich-Text-Formate („.docx“, „.rtf“) speichern Formatierungen als Binär- oder XML-Daten neben dem Text. Markdown speichert Formatierungen als sichtbare Klartextsymbole. Der Nachteil: Rich Text bietet Ihnen eine pixelgenaue Kontrolle auf Kosten der Portabilität; Markdown bietet Ihnen Portabilität und Geschwindigkeit auf Kosten einer fein abgestimmten Kontrolle.