💭 Jeremys Brain

MD-Cheatsheet

3 min read

Markdown Cheat Sheet

Grundlegende Textformatierung

SyntaxErgebnis
**fett** oder __fett__fett
*kursiv* oder _kursiv_kursiv
~~durchgestrichen~~durchgestrichen
`Inline Code`Inline Code
==Text markieren==Text markieren (kann je nach Renderer variieren)

Beispiel:

Das ist ein **fetter** und ein *kursiver* Text.

Überschriften

Markdown unterstützt sechs Ebenen von Überschriften. Du erzeugst sie mit dem Zeichen #.

SyntaxErgebnis
# H1H1
## H2H2
### H3H3
#### H4H4
##### H5H5
###### H6H6

Beispiel:

# Überschrift 1
## Überschrift 2
...

Listen (Aufzählungen)

Unsortierte Listen

- Punkt 1
- Punkt 2
  - Unterpunkt
    - Noch tiefer
 
* Punkt A
* Punkt B
  • Punkt 1
  • Punkt 2
    • Unterpunkt
      • Noch tiefer

Sortierte Listen

1. Erster Punkt
2. Zweiter Punkt
3. Dritter Punkt
  1. Erster Punkt
  2. Zweiter Punkt
  3. Dritter Punkt
[Text mit Link](https://example.com)
 
<https://example.com> (Automatischer Link)

Ergebnis:
Text mit Link
https://example.com

Bilder

![Alternativtext](https://example.com/bild.jpg)

Ergebnis:
Ein Bild wird eingefügt, das von der angegebenen URL geladen wird.

Zitate und Code-Blöcke

Zitate

> Dies ist ein Zitat.  
> Mehrzeilig möglich.
 
>> Verschachteltes Zitat.

Ergebnis:

Dies ist ein Zitat.
Mehrzeilig möglich.

Verschachteltes Zitat.

Code-Blöcke

```md
Dies ist ein Code-Block in Markdown-Syntax.
Mehrere Zeilen sind möglich.
```

Ergebnis:

Dies ist ein Code-Block in Markdown-Syntax.
Mehrere Zeilen sind möglich.

Tabellen

Tabellen können in GitHub-Flavored Markdown (GFM) erstellt werden:

| Spalte 1 | Spalte 2  | Spalte 3      |
|----------|-----------|---------------|
| Wert A1  | Wert B1   | Wert C1       |
| Wert A2  | Wert B2   | Wert C2       |

Ergebnis:

Spalte 1Spalte 2Spalte 3
Wert A1Wert B1Wert C1
Wert A2Wert B2Wert C2

Spalten können auch links, rechts oder zentriert ausgerichtet werden:

| Links  | Zentriert    | Rechts |
|:-------|:------------:|-------:|
| A      | B            | C      |
| Text   | Beispiel     | 100    |

Zeilenumbrüche und horizontale Linien

Zeilenumbrüche

  • Innerhalb eines Absatzes erzeugt ein einzelner Zeilenumbruch keinen neuen Absatz.
  • Für einen Zeilenumbruch nutzt man zwei Leerzeichen am Zeilenende oder <br> (je nach Renderer).

Horizontale Linien

---
***
___

Alle drei Varianten erzeugen eine horizontale Trennlinie.

Checkboxen (To-Do-Listen)

Diese Funktion ist hauptsächlich in GitHub-Flavored Markdown verbreitet.

- [ ] Offen
- [x] Erledigt

Ergebnis:

  • Offen
  • Erledigt

Fußnoten (GitHub-Flavored Markdown)

Hier ist ein Satz mit Fußnote.[^1]
 
[^1]: Dies ist der Text der Fußnote.

Ergebnis:
Hier ist ein Satz mit Fußnote.¹
(Am Ende des Dokuments erscheint die entsprechende Fußnote.)

Mathematische Ausdrücke (TeX)

Manche Markdown-Renderer (z. B. auf GitHub nicht nativ, jedoch in anderen Systemen wie Jupyter, Typora oder Markdown Preview Plus in VSCode) unterstützen LaTeX-Syntax:

  • Inline: $E = mc^2$

  • Block:

    $$
E = mc^2
$$

Ergebnis (abhängig vom Renderer)
E=mc2E = mc

Erweiterte Code-Block-Formatierung (Syntax-Highlighting)

Viele Code-Block-Syntaxen werden von GitHub unterstützt. Du gibst einfach die Sprache hinter den drei Backticks an:

```javascript
function halloWelt() {
  console.log('Hallo Welt!');
}

**Ergebnis:**  
Syntax-Highlighting in JavaScript.

---

## Inline-HTML

Man kann auch direkt **HTML-Tags** verwenden, sollte aber vorsichtig sein, da nicht jeder Markdown-Renderer alle HTML-Elemente zulässt.

```md
<p style="color:red;">Dieser Absatz ist rot.</p>

Ergebnis:

Weitere „coole“ Features und Tricks

  1. Emoji-Support:

    • GitHub-Flavored Markdown unterstützt Emojis wie :smile: → :smile:
    • Man kann auch Unicode-Emojis einfügen: 🚀

  2. Diagramme (z. B. mermaid)

    graph LR;
    A --> B;
    B --> C;
    C --> A;

    (Muss vom jeweiligen Renderer unterstützt werden.)

  3. Collapse-Text (nur auf manchen Plattformen wie GitHub möglich):

    <details>
<summary>Ausklappen, um mehr zu sehen</summary>
 
Versteckter Text, der erst beim Ausklappen sichtbar wird.
 
</details>

    Ergebnis: Ein ausklappbares Element.

  4. Front Matter (z. B. in Jekyll, Hugo, VSCode-Blog):

    ---
title: Mein Beitrag
date: 2023-10-12
tags: [markdown, cheat-sheet]
---

    (Metadaten, die von bestimmten Werkzeugen verarbeitet werden.)

  5. Task-Lists in Issues/PRs (GitHub):

    • ToDo 1
    • ToDo 2

Graph View