Diese Referenz dokumentiert die technischen Bestandteile von mdBook. Sie dient als Nachschlagewerk für Dateien, Befehle und Konfigurationsoptionen.
| Datei/Ordner | Beschreibung |
|---|
book.toml | Hauptkonfiguration des Projekts |
src/ | Enthält alle Markdown-Dateien |
src/SUMMARY.md | Definiert die Kapitelstruktur |
book/ | Generierte Ausgabe |
| Befehl | Beschreibung |
|---|
mdbook init <name> | Neues Projekt erstellen |
mdbook build | Buch generieren |
mdbook serve | Lokalen Entwicklungsserver starten |
mdbook test | Codebeispiele testen |
mdbook clean | Build-Artefakte entfernen |
mdbook --version | Versionsnummer anzeigen |
| Option | Typ | Beschreibung |
|---|
title | String | Titel des Buches |
authors | Array | Autoren |
language | String | Sprache |
src | String | Quellverzeichnis |
| Option | Beschreibung |
|---|
default-theme | Standard-Theme |
preferred-dark-theme | Bevorzugtes Dark-Theme |
git-repository-url | Repository-Link |
edit-url-template | Bearbeitungslink |
| Syntax | Funktion |
|---|
- [Kapitel](kapitel.md) | Kapitel hinzufügen |
| Einrückung mit Leerzeichen | Unterkapitel erstellen |
--- | Trennlinie einfügen |
# Summary
- [Einleitung](README.md)
- [Kapitel 1](chapter_1.md)
- [Unterkapitel](subchapter.md)
| Element | Beispiel |
|---|
| Überschrift | # Titel |
| Aufgabenliste | - [ ] Aufgabe |
| Codeblock | ```rust |
mdbook serve --open starten- Markdown-Dateien in
src/ bearbeiten
- Änderungen im Browser live prüfen
- Mit
mdbook build finale HTML-Ausgabe erzeugen
| Befehl | Beschreibung |
|---|
mdbook serve | Server starten (ohne Browser öffnen) |
mdbook serve --open | Server starten und Browser öffnen |
mdbook serve -p 8080 | Anderen Port verwenden |
mdbook build | HTML-Ausgabe generieren |
mdbook clean | book/-Verzeichnis leeren |
| Format | Unterstützung |
|---|
| HTML | Standard |
| PDF | Über Plugins |
| EPUB | Über Plugins |
| JSON | Für Tooling |
| Option | Bedeutung |
|---|
bibliography | Pfad zur exportierten BibTeX-Datei |
title | Titel des automatisch generierten Literaturverzeichnisses |
style | Zitationsstil, z.B. ieee, apa, chicago |