Tutorial

Voraussetzungen

Für mdBook müssen Rust und Cargo installiert sein: https://rust-lang.org/tools/install/

Überprüfen der Installation:

rustc --version
cargo --version

mdBook installieren

Cargo ist der Paketmanager von Rust und wird zur Installation von mdBook verwendet:

cargo install mdbook

Überprüfen der Installation:

mdbook --version

Erstes Projekt erstellen

Ein neues mdBook-Projekt erzeugen:

mdbook init seminar-mdbook

In das Projektverzeichnis wechseln:

cd seminar-mdbook

Projektstruktur

seminar-mdbook/
    book/
    src/
        SUMMARY.md
        chapter_1.md
    book.toml

Lokalen Entwicklungsserver starten

Der Entwicklungsserver ist über Localhost erreichbar und ermöglicht Live Reload bei Dateiänderungen.

mdbook serve --open

Die Dokumentation ist anschließend unter:

http://localhost:3000

erreichbar. Änderungen an Markdown-Dateien werden automatisch erkannt und der Browser aktualisiert sich ohne manuellen Reload.

Dokumentation bauen

Zum Generieren der fertigen HTML-Ausgabe:

mdbook build

Die Ausgabe landet im book/-Verzeichnis und kann direkt auf einem Webserver deployed werden. Das Deploy der statischen HTML-Ausgabe auf einen Webserver ist damit ohne weitere Konfiguration möglich.

Wichtige Dateien

Die Datei SUMMARY.md definiert die Navigation und Kapitelstruktur des Buchs. Die Datei book.toml ist die Konfigurationsdatei des Projekts und steuert Titel, Autoren und Plugins.

Mermaid-Einbindung

Installation

cargo install mdbook-mermaid

mdbook-mermaid install

Anschließend in die book.toml einbinden.

Zotero & Literaturverwaltung

Voraussetzungen

• Zotero installiert und Quellen gesammelt [2]
• mdBook-Projekt vorhanden

Installation

Das Plugin mdbook-bibtex wird über Cargo installiert:

cargo install mdbook-bibtex

Konfiguration in book.toml

Anschließend wird das Plugin in der book.toml konfiguriert: [3]

[preprocessor.bibtex]
bibliography = "src/zotero_seminar/zotero_seminar.bib"
title = "Literaturverzeichnis"
style = "ieee"

Bibliothek aus Zotero exportieren

1. Zotero öffnen
2. Sammlung rechtsklick -> Exportieren
3. Format BibTeX wählen
4. Datei speichern unter src/zotero_seminar/zotero_seminar.bib

Zitieren im Text

Zitationen werden direkt im Markdown eingebunden:

mdBook ist ein Static Site Generator. <a href="literaturverzeichnis.md#noauthor_installation_nodate"><abbr title="“Installation - mdBook Documentation.” Accessed: June 18, 2026. [Online]. Available: https://rust-lang.github.io/mdBook/guide/installation.html">[1]</abbr></a>

Der Zitierschlüssel entspricht dem Schlüssel in der .bib-Datei. Das Literaturverzeichnis wird von mdbook-bibtex automatisch am Ende des Buchs generiert.

Ergebnis

Beim Build erzeugt mdbook-bibtex automatisch:

• Inline-Zitationen im gewählten Stil (hier: IEEE)
• Ein vollständiges Literaturverzeichnis am Ende des Buchs