Zum Hauptinhalt springen

Markdown-Spickzettel & Syntax-Leitfaden

Kopieren Sie funktionierende Codebeispiele, prüfen Sie die gerenderte Vorschau und passen Sie die Syntax für Ihre Dokumentation an.

Überschriften

Setzen Sie 1 bis 6 #-Symbole vor eine Zeile. Mehr Symbole erzeugen eine untergeordnete Überschrift.

Syntax vs. Vorschau
Kopierbare Syntax
# Heading Level 1
## Heading Level 2
### Heading Level 3
#### Heading Level 4
##### Heading Level 5
###### Heading Level 6
Gerenderte Vorschau

Heading Level 1

Heading Level 2

Heading Level 3

Heading Level 4

Heading Level 5
Heading Level 6

Fett, kursiv und durchgestrichen

Umschließen Sie Text mit Sternchen, Unterstrichen oder Tilden, um ihn hervorzuheben oder gelöschten Text anzuzeigen.

Syntax vs. Vorschau
Kopierbare Syntax
This text is *italicized*.
This text is _italicized_ as well.

This text is **bolded**.
This text is __bolded__ as well.

This text is ***bold and italicized***.

This text is ~~strikethrough~~.
Gerenderte Vorschau

This text is italicized.

This text is italicized as well.

This text is bolded.

This text is bolded as well.

This text is bold and italicized.

This text is strikethrough.

Nummerierte, unnummerierte und Aufgabenlisten

Verwenden Sie Zahlen für nummerierte Schritte, Bindestriche für Aufzählungspunkte und eckige Klammern mit x für Aufgaben.

Syntax vs. Vorschau
Kopierbare Syntax
- Unordered list item 1
- Unordered list item 2
  - Indented nested item

1. Ordered list item 1
2. Ordered list item 2

- [x] Completed task item
- [ ] Incomplete task item
Gerenderte Vorschau
  • Unordered list item 1
  • Unordered list item 2
    • Indented nested item
  1. Ordered list item 1
  2. Ordered list item 2
  • Completed task item
  • Incomplete task item

Inline-Code und Codeblöcke

Nutzen Sie einfache Backticks für Inline-Code und dreifache Backticks mit Sprachkürzel für Codeblöcke.

Syntax vs. Vorschau
Kopierbare Syntax
Use inline `const value = true` variables.

Fenced code block:
```javascript
const greeting = "Hello, developer!";
console.log(greeting);
```
Gerenderte Vorschau

Use inline const value = true variables.

javascript
const greeting = "Hello, developer!";
console.log(greeting);

Tabellen und Spaltenausrichtung

Trennen Sie Spalten mit Pipe-Zeichen und steuern Sie die Ausrichtung mit Doppelpunkten in der Trennzeile.

Syntax vs. Vorschau
Kopierbare Syntax
| Parameter | Type | Default |
| :--- | :---: | ---: |
| format | string | "MD" |
| local | boolean | true |
| threads | number | 4 |
Gerenderte Vorschau
Parameter Type Default
format string "MD"
local boolean true
threads number 4

Zitate und verschachtelte Zitate

Beginnen Sie Zeilen mit einem Größer-als-Zeichen, um Zitate oder hervorgehobene Hinweise zu erstellen.

Syntax vs. Vorschau
Kopierbare Syntax
> This is a blockquote element.
>
> > This is nested inside the parent quote.
Gerenderte Vorschau

This is a blockquote element.

This is nested inside the parent quote.

Trennlinien, Fußnoten und HTML

Nutzen Sie drei Bindestriche für Trennlinien, Zirkumflex-Klammern für Fußnoten oder Inline-HTML-Tags.

Syntax vs. Vorschau
Kopierbare Syntax
Create dividers with asterisks:
***

Escape characters with backslash:
\* Literal asterisk (not bullet)

Embed keyboard labels:
<kbd>Cmd</kbd> + <kbd>Option</kbd>
Gerenderte Vorschau

Create dividers with asterisks:


Escape characters with backslash:
* Literal asterisk (not bullet)

Embed keyboard labels:
Cmd + Option

Häufig gestellte Fragen

Was ist Markdown?

Markdown ist eine schlanke Auszeichnungssprache, mit der Sie Klartext mit einfachen, lesbaren Symbolen strukturieren können.

Wird GitHub-Flavored Markdown (GFM) unterstützt?

Ja. Diese Referenz und der integrierte Editor unterstützen Aufgabenlisten, Tabellen, Durchstreichungen, Autolinks und Codeblöcke.

Wie erzeuge ich einen Zeilenumbruch?

Beenden Sie eine Zeile mit zwei Leerzeichen vor dem Drücken der Eingabetaste, oder lassen Sie eine Leerzeile für einen neuen Absatz.

Kann ich HTML in Markdown verwenden?

Ja. Die meisten Markdown-Renderer erlauben Standard-HTML-Tags für Layouts.