---
# System prepended metadata

title: Markdown Einstieg
tags: [markdown]

---

# Markdown Einstieg

Markdown ist eine einfache Auszeichnungssprache um Textdokumente zu strukturieren. Es haben sich viele Dialekte und Schreibweisen etabliert.

In den folgenden Kapiteln werden die Markdown-Elemente ausführlicher am Beispiele gezeigt.

**Wichtig:** Vor und Nach allen Elementen (Überschriften, Listen, Formeln, Tabellen, etc.) sollte eine Leerzeile eingefügt werden.

## Überschriften

Zur Strukturierung eines Dokuments werden Überschriften (H1 bis H6) genutzt.
Es werden 1-6 "#" gefolgt von einem Leerzeichen vor die Überschrift gesetzt:

``` plaintext
# H1 Überschrift
## H2 Überschrift
### H3 Überschrift
#### H4 Überschrift
##### H5 Überschrift (vermeiden)
###### H6 Überschrift (vermeiden)
```

Beispiele für die Überschriften:

# H1 Überschrift

## H2 Überschrift

### H3 Überschrift

#### H4 Überschrift

---

## Grundlagen Formatierungen

Eine **Trennlinie**  wird durch drei Bindestriche "-" erzeugt:

``` plaintext
---
```

Beispiel:

---

Wird vor und nach einem Text **eine Leerzeile** gelassen, entsteht ein **Absatz**.

Dieser Absatz hat einen hat automatisch einen Abstand nach oben und unten.

---

Folgende Formatierungen sind in Markdown möglich:

``` plaintext
- *kursiv*
- **fett** 
  (Alternativ zu * kann - eingesetzt werden - vermeiden)
- ***fettkursiv*** (vermeiden)
- ~~durchgestrichen~~ (vermeiden)
- Text^hochgestellt^ (vermeiden)
- Text~tiefgestellt~ (vermeiden)
- ++unterschrichen++ (vermeiden)
```

Beispiel:

- *kursiv*
- **fett**
- ***fettkursiv*** (vermeiden)
- ~~durchgestrichen~~ (vermeiden)
- Text^hochgestellt^ (vermeiden)
- Text~tiefgestellt~ (vermeiden)
- ++unterschrichen++ (vermeiden)

Es sollte nur *kursiv* oder **fett** genutzt werden.

Tiefgestellt und unterstrichen funktioniert nicht in Liascript.

---

## Liste

Nach jedem Listenpunkt steht genau **ein** Leerzeichen:
- unsortierte Liste `- ` 
- sortierte Liste `1. `
- Aufgabenliste `- [ ] `

Es sind folgende Listen möglich (mit Beispielen):

``` plaintext
unsortierte Liste: 

- Erster Punkt
- Zweiter Punkt
- Dritter Punkt
```

unsortierte Liste:

- Erster Punkt
- Zweiter Punkt
- Dritter Punkt

``` plaintext
sortierte Liste:

1. Erster Punkt
2. Zweiter Punkt
3. Dritter Punkt
```

sortierte Liste:

1. Erster Punkt
2. Zweiter Punkt
3. Dritter Punkt

``` plaintext
strukturierte Liste:

- Erster Punkt
  - Erster Unterpunkt
  - Zweiter Unterpunkt
- Zweiter Punkt
- Dritter Punkt
```

strukturierte Liste:

- Erster Punkt
  - Erster Unterpunkt
  - Zweiter Unterpunkt
- Zweiter Punkt
- Dritter Punkt

``` plaintext
Aufgabenliste: 

- [ ] Erste Aufgabe
- [ ] Zweite Aufgabe
- [x] Dritte Aufgabe (erledigt)
```

Aufgabenliste:

- [ ] Erste Aufgabe
- [ ] Zweite Aufgabe
- [x] Dritte Aufgabe (erledigt)

---

## Link

Links haben folgenden Aufbau:

``` plaintext
[Linktext](URL)
```

Beipsiel:

`[Jade Hochschule](http://jade-hs.de)`

führt zu:

[Jade Hochschule](http://jade-hs.de)

Varianten für Links:

- vollständige URL: `http://jade-hs.de`
- relative URL (Pfad): `[Text](/bilder/bild.png)`
- Verweis zu Überschrift: `[Text](# Name-der-Überschrift)`

Das direkte Schreiben einer Internetadresse z.B. "jade-hs.de" funktioniert, sollte aber vermieden werden.

---

## Bild

Bilder sind wie Links aufgebaut  `!` voran:

``` text
![Bildbeschreibung](URL_zum_Bild.png)
```

Beispiel:

`![Jade Hochschule](https://www.jade-hs.de/typo3conf/ext/jhs_site/Resources/Public/Images/jadehs-logo.png)`

führt zu:

![Jade Hochschule](https://www.jade-hs.de/typo3conf/ext/jhs_site/Resources/Public/Images/jadehs-logo.png)

## Formel

Eine Formel in der Zeile (Inline) wie ${\sum_{k = 1}^{n} x^k}$, wird durch umschließende $ ermöglicht:

``` latex
${\sum_{k = 1}^{n} x^k}$
```

Eine Formel als Block wird durch umschließende \$\$ möglich. Beispiel:

$$
\frac
  {\sum_{k = 1}^{n} x^k + k ! }
  { a^2 − b^2}
$$

```latex
$$
\frac
  {\sum_{k=1}^{n} x^k + k ! }
  { a^2 − b^2}
$$
```

Formeln werden in Latex geschrieben. Ein empfehlenswerter Formeleditor dafür wäre:
https://editor.codecogs.com/

## Block

## Quelltext

## Zitate, Gespräche

> [name=Rico M]
> [time=Sun, Dec 8, 2024 9:06 AM]
>
> [color=#0000dd]
> > test
> > [color=#dd0000]

> test
>
> [Markdown Syntax Reference](/9iTFcssSTZ-f24wmhbXUNw)
> [reference]: https://hackmd.io/iSxk5vczQWqtoHmRzFzmgQ

### Fusszeilen (kritisch prüfen!)

## Tabelle

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Text     | Text     | Text     |

## Markdown im Projekt OERit

**Wichtig!** Folgendes ist zu beachten:

- Diese Regeln müssen im gesamten Projekt eingehalten werden!
- Nutzen Sie nur, was Sie verstehen und benötigen!
- Vor und nach jedem Element muss idR eine Leerzeile stehen.
  - Elemente sind Überschriften, Absätze, Listen, Zitate, Bilder, Links, Formeln und Quelltexte.
  - Viele Elemente können miteinander kombiniert werden.
  - Erweiterte Elemente (siehe unten) sind Tabellen, Fussnoten, Emojis.

---

<!-- ![image](https://hackmd.io/_uploads/BJWKKOG4Jx.png) -->

Menü hackmd.io:
![hackmd_menu_nummeriert](https://hackmd.io/_uploads/B1stcafNye.png)
Menü Hedgedoc (GWDG):
![headgedoc_menu](https://hackmd.io/_uploads/ryGY6S7V1e.png)

1. zurück
2. wiederherstellen
3. Fett
4. Kursiv
5. Durchgestrichen
6. Überschriften
7. Quelltext
8. Zitat
9. Liste, Aufzählung
10. nummerierte Liste
11. Aufgabenliste
12. Link
13. Bild
14. Tabelle
15. horizontale Linie
16. Kommentar

die kollaborativen Editoren HackMD, Headgedoc und das darauf aufbauende Liascript.

## Editor > Menü

Menü HackMD und Hedgedoc (3-16 sind gleich)
![hackmd_menu_nummeriert](https://hackmd.io/_uploads/B1stcafNye.png)
![headgedoc_menu](https://hackmd.io/_uploads/ryGY6S7V1e.png)

| Menu | Markdown | Aktion(en)                  |
| ---  | ------ | -------------                 |
| 1, 2 |        | <- zurück -> wiederherstellen |
| 3, 4 | `*`    | Formatierung \* kursiv \*\* fett |
| 5    | `~~`   | Formatierung \~~ durchgestrichen |
| 6    | `#`    | Überschrift # H1 bis ###### H6|
| 7    | \`\`\` | Quelltext bzw. mit \` in Zeile|
| 8    | `>`    | Zitat >, Gespräch > >         |
| 9    | `-`    | unsortierte Liste             |
| 10   | `1.`   | sortierte Liste               |
| 11   | `- [ ]`| Aufgabenliste                 |
| 12   | `[Text](URL)`  | Link, Verweis         |
| 13   | `![Text](URL)` | Bild                  |
| 14   | \| -   | Tabelle                       |
| 15   | `---`  | Trennlinie                    |
| 16   | `> [name=x]`   | Kommentar             |

## Kurzübersicht

| Element           | Markdown   |
| ----------------- | ---------- |
| Überschrift       | `# H1` <br /> `## H2` <br /> `### H3`<br /> `#### H4` |
| Fett              | `**fett**`                       |
| Kursiv            | `*kursiv*`                       |
| Absatz            | Text (davor und danach Leerzeile)|
| Trennlinie        | `---`                            |
| sortierte Liste   | 1. Erster Punkt <br /> 2. Zweiter Punkt <br /> 3. Dritter Punkt                          |
| unsortierte Liste | - Erster Punkt <br /> - Zweiter Punkt <br /> -  Dritter Punkt                          |
| Link              | `[Linktitel](http://jade-hs.de)` |
| Bild              | `![Bildtitel](bild.png)`         |
| Formel in Zeile   | `$Latexformel in Zeile$`         |
| Formel als Block  | `$$ Latexformel als Block $$`    |
| Quelltext in Zeile| \`Quelltext in Zeile\`           |
| Quelltext in Block| \`\`\` Quelltext im Block \`\`\` |
| Zitat             | `> Zitat`                        |
