Skip to content

Kapitel 14: Markdown für verschiedene Anwendungsbereiche

In diesem Kapitel lernen Sie, wie Sie Markdown für unterschiedliche Zwecke anpassen.

14.1 Akademisches Schreiben

Struktur einer akademischen Arbeit

markdown
---
title: "Titel der Arbeit"
author: Max Mustermann
date: 2024-01-15
abstract: "Kurzzusammenfassung..."
keywords: [Markdown, Akademisch, Pandoc]
---

# Einleitung

## Hintergrund

## Forschungsfrage

# Hauptteil

## Theorie

## Methode

# Fazit

# Literaturverzeichnis

Zitationen mit Pandoc

Verwenden Sie eine .bib-Datei:

bibtex
@article{smith2020,
  author = {Smith, John},
  title = {Markdown in Academia},
  year = {2020},
  journal = {Journal of Markdown Studies}
}

In Ihrer Markdown-Datei:

markdown
Wie Smith (2020) gezeigt hat...

# Literaturverzeichnis

Konvertieren mit Pandoc:

bash
pandoc input.md -o output.pdf --bibliography=bibliography.bib --citeproc

Fußnoten

markdown
Das ist ein wichtiger Punkt[^1].

[^1]: Das ist die Erklärung dazu.

14.2 Technische Dokumentation

README.md Struktur

markdown
# Projektname

![Build Status](https://img.shields.io/badge/build-passing-brightgreen)

## Beschreibung

Kurze Beschreibung des Projekts.

## Installation

Schritte zur Installation.

## Nutzung

Beispiele zur Nutzung.

## API-Dokumentation

## Beitragen

Richtlinien für Beiträge.

## Lizenz

MIT

API-Dokumentation

markdown
## API-Endpunkte

### `GET /users`

Gibt eine Liste von Benutzern zurück.

**Parameter**:
- `limit` (optional): Maximale Anzahl
- `offset` (optional): Offset für Paginierung

**Beispiel**:
```bash
curl https://api.example.com/users?limit=10

Antwort:

json
{
  "users": [...]
}

### Code-Dokumentation

```markdown
## `function berechne(x, y)`

Berechnet das Produkt von `x` und `y`.

**Parameter**:
- `x` (Number): Erster Faktor
- `y` (Number): Zweiter Faktor

**Rückgabe**: Number

**Beispiel**:
```javascript
berechne(3, 4); // Gibt 12 zurück

## 14.3 Kreatives Schreiben

### Bücher mit Markdown

Verwenden Sie Pandoc für Bücher:

```bash
pandoc vorwort.md teil1.md teil2.md appendix.md -o buch.pdf --table-of-contents --number-sections --top-level-division=chapter

Lyrik

markdown
## Gedicht: "Der Sommer"

Der Himmel blau, die Sonne scheint,
Die Vögel singen, gar nicht klein.

- Strophe 1
- Strophe 2

Drehbuch

markdown
# Szene 1

**Ort**: Park

**Zeit**: Tag

**Figuren**:
- MAX
- SARAH

MAX
(denkt nach)
Ich glaube, Markdown ist toll.

SARAH
(lacht)
Allerdings!

14.4 Business-Dokumente

Meeting-Notizen

markdown
# Meeting: Projekt "Alpha"

**Datum**: 2024-01-15
**Teilnehmer**: Max, Sarah, Tom

## Agenda

1. Stand des Projekts
2. Probleme
3. Nächste Schritte

## Notizen

### Stand des Projekts
- Frontend fertig
- Backend in Arbeit

### Probleme
- Verzögerung bei API

## To-Do

- [ ] API bis Freitag fertigstellen (Tom)
- [ ] Design besprechen (Sarah)

## Nächstes Meeting

2024-01-22, 14:00 Uhr

Projektplan

markdown
# Projektplan: Webseite relaunch

## Ziele

- Moderneres Design
- Bessere Performance
- Mobile Optimierung

## Meilensteine

### Meilenstein 1: Design (bis 2024-02-01)
- [x] Mockups erstellen
- [ ] Feedback einholen

### Meilenstein 2: Entwicklung (bis 2024-03-01)
- [ ] Frontend umsetzen
- [ ] Backend anpassen

## Ressourcen

- Designer: Sarah
- Entwickler: Max, Tom

14.5 Präsentationen

reveal.js

Markdown für HTML-Präsentationen:

markdown
---
title: Meine Präsentation
---

# Folie 1

Das ist der Inhalt der ersten Folie.

---

## Folie 2

- Punkt 1
- Punkt 2

---

## Folie 3

```javascript
console.log("Hallo");
```

Konvertieren:

bash
pandoc praesentation.md -o praesentation.html -t revealjs

Marp

Marp verwendet Markdown für Präsentationen:

markdown
---
marp: true
theme: default
---

# Titel der Präsentation

## Untertitel

---

## Folie 2

- Punkt 1
- Punkt 2
```

14.6 Zusammenfassung

In diesem Kapitel haben Sie gelernt:

  • ✅ Akademisches Schreiben (Zitationen, Fußnoten)
  • ✅ Technische Dokumentation (README, API)
  • ✅ Kreatives Schreiben (Bücher, Lyrik)
  • ✅ Business-Dokumente (Meeting-Notizen, Projektpläne)
  • ✅ Präsentationen (reveal.js, Marp)

Im nächsten Kapitel werden wir fortgeschrittene Tipps und Tricks lernen!


Übung: Wählen Sie einen Anwendungsbereich (z.B. technische Dokumentation) und erstellen Sie ein Beispiel-Dokument (z.B. API-Dokumentation für eine fiktive App).

Frei für alle Anfänger