Markdown

Markdown stellt eine einfache Auszeichnungssprache dar, mit der man Text leicht formatieren kann. Sie wird häufig für Dokumentationen, README-Dateien und Blogs verwendet, weil sie leicht zu schreiben ist und sich mit Hilfe einer Konvertierungssoftware gut in HTML umwandeln lässt. Plattformen wie GitHub erweitern dabei oftmals die Standard-Syntax um hilfreiche Funktionen wie z.B. Tabellen, Nachrichtenblöcke und Code-Highlighting. Auch der Webseiten-Generator Docusaurus, mit dem diese Webseite erstellt wurde, sowie die meisten GenAI-Chatbots verwenden Markdown.

Hilfreiche Links

Textformatierungen

Syntax	Ergebnis
`Text` oder `_Text_`	Text
`Text` oder `__Text__`	Text
`*Text*` oder `___Text___`	*Text*
`~~Text~~` oder `~Text~`	~~Text~~
`<ins>Text</ins>`	Text
`<sup>Text</sup>`	^Text
`<sub>Text</sub>`	_Text
`Codezeile`	`Codezeile`
`:heart:`	❤️

Überschriften

Syntax
Ergebnis

# Überschrift 1
## Überschrift 2
### Überschrift 3

Links und Abbildungen

Syntax
Ergebnis

[Markdown](https://de.wikipedia.org/wiki/Markdown)

![Alternativer Text](https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Markdown-mark.svg/208px-Markdown-mark.svg.png)

Listen

Syntax
Ergebnis

**Ungeordnete Liste**
- Java
- Python
- C++

**Aufgabenliste**
- [ ] Wäsche waschen
- [X] Zimmer aufräumen
- [ ] Rasen mähen

**Geordnete Liste**
1. Freiburg
2. Hamburg
3. Berlin

Tabellen

Syntax
Ergebnis

| Name  | Alter | Geschlecht |
| ----- | ----- | ---------- |
| Hans  | 27    | m          |
| Lisa  | 31    | w          |
| Peter | 19    | m          |

Name	Alter	Geschlecht
Hans	27	m
Lisa	31	w
Peter	19	m

Codeblöcke

Syntax
Ergebnis

```java
public class MainClass {
   public static void main() {
      System.out.println("Hello World");
   }
}
```

public class MainClass {
   public static void main() {
      System.out.println("Hello World");
   }
}

Zitatblöcke

Syntax
Ergebnis

> "C makes it easy to shoot yourself in the foot;
> C++ makes it harder, but when you do, it blows away your whole leg."
> (Bjarne Stroustrup)

Nachrichtenblöcke

Syntax
Ergebnis

**GitHub-Flavored-Markdown**

> [!NOTE]
> Ein einfacher Hinweis

> [!TIP]
> Ein hilfreicher Hinweis

> [!IMPORTANT]
> Ein wichtiger Hinweis

> [!WARNING]
> Eine Warnung

> [!CAUTION]
> Eine deutliche Warnung

**Docusaurus**

:::note[Hinweis]
Ein einfacher Hinweis
:::

:::tip[Tipp]
Ein hilfreicher Hinweis
:::

:::info[Information]
Eine einfache Information
:::

:::warning[Warnung]
Eine Warnung
:::

:::danger[Warnung]
Eine deutliche Warnung
:::

Mermaid-Diagramme

Syntax
Ergebnis

**Klassendiagram**
```mermaid
classDiagram
   Gender --o Person
   class Gender {
      <<enumeration>>
      MALE, FEMALE, INTERSEX
   }
   class Person {
      <<record>>
      name: String
      age: int
      gender: Gender
   }
```

**Flussdiagram**
```mermaid
flowchart LR
    a[a]
    b{{b}}
    c[/c/]
    d(d)
    a --> b
    b --> c
    c --> d
```

**Kuchendiagramm**
```mermaid
pie
    "PS4" : 117
    "XONE" : 58
    "NSW" : 153
```

Hinweis

Mermaid ist eine Auszeichnungssprache, die es ermöglicht, Diagramme (z.B. Klassendiagramme und Flussdiagramme) aus Code zu erstellen.

Fußnoten

Syntax
Ergebnis

Markdown [^1]

[^1]: Eine einfache Auszeichnungssprache (vg. https://de.wikipedia.org/wiki/Markdown)

Horizontale Linien

Syntax
Ergebnis

---

Eine einfache Auszeichnungssprache (vgl. https://de.wikipedia.org/wiki/Markdown) ↩

Hilfreiche Links​

Textformatierungen​

Überschriften​

Überschrift 1

Überschrift 2​

Überschrift 3​

Links und Abbildungen​

Listen​

Tabellen​

Codeblöcke​

Zitatblöcke​

Nachrichtenblöcke​

Mermaid-Diagramme​

Fußnoten​

Horizontale Linien​

Footnotes​