Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Glossar

mdBook
Tool zur Erstellung von Dokumentations-Webseiten aus Markdown-Dateien, entwickelt in Rust.
Markdown
Leichtgewichtige Auszeichnungssprache, die einfachen Text in HTML umwandelt.
Rust
Systemprogrammiersprache mit Fokus auf Sicherheit und Performance.
Statische HTML-Webseite
Webseite, die nur aus fixen HTML-Dateien besteht und keine serverseitige Verarbeitung benötigt.
Cargo
Paketmanager und Build-Tool von Rust, wird zur Installation von mdBook verwendet.
SUMMARY.md
Zentrale Datei eines mdBook-Projekts, die Navigation und Kapitelstruktur definiert.
book.toml
Konfigurationsdatei eines mdBook-Projekts, steuert Titel, Autoren und Plugins.
Localhost
Lokale Netzwerkadresse (http://localhost:3000) über die der mdBook-Entwicklungsserver erreichbar ist.
Deploy
Veröffentlichung der fertigen statischen HTML-Ausgabe auf einem Webserver.
Live Reload
Automatische Aktualisierung des Browsers wenn Markdown-Dateien geändert werden, ohne manuellen Reload.
Codeblock
Abschnitt in Markdown der Code darstellt, in mdBook können Rust-Codeblöcke direkt im Browser ausgeführt werden.
Rust Playground
Browser-basierte Umgebung zum Ausführen von Rust-Code, in mdBook über den Play-Button erreichbar.
Doctest
Automatisch testbarer Codeblock direkt in der Dokumentation, ausführbar mit mdbook test.
Editable
Attribut für Rust-Codeblöcke das dem Leser erlaubt den Code direkt im Browser zu bearbeiten.
Mermaid
Diagramm-Werkzeug das Diagramme aus Textbeschreibungen generiert, in mdBook über das mdbook-mermaid Plugin eingebunden.
BibTeX
Format zur Verwaltung und Speicherung von Literaturquellen, das vor allem im LaTeX-Umfeld verwendet wird.
JupyterBook
Dokumentationstool für Data Scientists und Wissenschaftler, unterstützt ausführbare Jupyter Notebooks.
Jupyter Notebook
Interaktives Dokument das Code, Text und Ausgaben kombiniert, unterstützt Python, R und Julia.
Static Site Generator
Tool das aus Quelldateien wie Markdown fertige statische HTML-Webseiten generiert.
Diátaxis
Framework zur Strukturierung von Dokumentation in vier Typen: Tutorial, How-to Guide, Explanation und Reference.