ESC
Markdown-Syntax

Headings

Syntax Shorthand Example Rendered Notes
# Heading H1 # My Title H1 Largest heading; maps to <h1>
## Heading H2 ## Section H2 Maps to <h2>
### Heading H3 ### Subsection H3 Maps to <h3>
#### Heading H4 #### Detail H4 Maps to <h4>
##### Heading H5 ##### Note H5 Maps to <h5>
###### Heading H6 ###### Fine print H6 Smallest heading; maps to <h6>

Emphasis

Syntax Shorthand Example Rendered Notes
**text** Bold **hello** hello Also __text__
*text* Italic *hello* hello Also _text_
***text*** Bold + Italic ***hello*** hello Also ___text___
~~text~~ Strikethrough ~~hello~~ hello Requires GFM support
`code` Inline code `var x = 1` var x = 1 Monospace; escapes HTML

Links & Images

Syntax Shorthand Example Rendered Notes
[text](url) Inline link [Google](https://google.com) Google Opens in same tab by default
[text](url "title") Link + title [G](https://g.com "Go") Google Title shown on hover
[text][ref] Reference link [Google][g] ... [g]: url Google Define URL elsewhere in doc
![alt](url) Inline image ![Logo](logo.png) <img> Alt text improves accessibility
<url> Autolink <https://example.com> link URL or email becomes clickable

Lists

Syntax Shorthand Example Rendered Notes
- item Unordered - Apple - Banana * Apple Also * or + as bullet
1. item Ordered 1. First 2. Second 1. First Numbers auto-increment in output
- nested Nested list - Item - Sub * Item > Sub Indent 2+ spaces to nest
- [ ] task Task (unchecked) - [ ] Todo [ ] Todo GitHub Flavored Markdown
- [x] task Task (checked) - [x] Done [x] Done GFM checked task item

Code Blocks

Syntax Shorthand Example Rendered Notes
```lang Fenced block ```js code ``` <pre> Language hint enables syntax highlight
code Indented block let x = 1; <pre> 4 spaces or 1 tab indentation
`code` Inline code Use `npm install` npm install Single backtick pair

Blockquotes

Syntax Shorthand Example Rendered Notes
> text Blockquote > This is a quote " quote Renders as <blockquote>
>> text Nested quote >> Inner quote "" inner Double > for nested blockquote
> **Note** Callout style > **Warning:** text callout Bold first word for callout pattern

Tables

Syntax Shorthand Example Rendered Notes
| Col | Col | Header row | Name | Age | <th> Pipes define columns
|-----|-----| Separator | --- | --- | divider Required after header row
| :--- | Left align | :--- | left Colon on left side
| ---: | Right align | ---: | right Colon on right side
| :---: | Center align | :---: | center Colons on both sides

Horizontal Rules

Syntax Shorthand Example Rendered Notes
--- Rule (hyphens) --- <hr> Three or more hyphens
*** Rule (asterisks) *** <hr> Three or more asterisks
___ Rule (underscores) ___ <hr> Three or more underscores

Escaping

Syntax Shorthand Example Rendered Notes
\* Escape char \*literal\* *literal* Backslash escapes: \\ ` * _ { } [ ] ( ) # + - . !

Häufig gestellte Fragen

Markdown ist eine leichtgewichtige Auszeichnungssprache, die 2004 von John Gruber erstellt wurde und es ermöglicht, einfachen Text zu schreiben, der in HTML umgewandelt wird. Eine Zeile, die mit # beginnt, wird zu <h1>, **Text** wird fett und *Text* wird kursiv. Da es sich als Klartext natürlich liest und sauberes HTML erzeugt, wurde es zum Standard für README-Dateien, Dokumentationen, Foren wie Reddit und Stack Overflow sowie Notiz-Apps.

CommonMark ist eine strenge, eindeutige Spezifikation für Markdown, die jahrelange Inkonsistenz zwischen Implementierungen behebt. GitHub Flavored Markdown (GFM) erweitert CommonMark um Aufgabenlisten (- [ ] / - [x]), Tabellen, Durchstreichung (~~Text~~) und Autolinks. Die meisten Entwicklerplattformen — GitHub, GitLab, VS Code — verwenden GFM.

Eine leere Zeile erstellt einen neuen Absatz. Für einen Zeilenumbruch innerhalb eines Absatzes ohne einen neuen zu beginnen, beende die Zeile mit zwei oder mehr Leerzeichen vor dem Drücken von Enter. Alternativ akzeptieren einige Parser am Zeilenende einen Backslash \. Der sicherste plattformübergreifende Ansatz ist eine leere Zeile für Absatzumbrüche und das HTML-Tag <br> für Umbrüche innerhalb des Absatzes.