Einleitung
Fumadocs (Foo-ma docs) ist ein Dokumentationsframework auf Basis von Next.js. Es ist schnell und flexibel und fügt sich nahtlos in den Next.js App Router ein.
Fumadocs besteht aus mehreren Teilen:
Fumadocs Core
Übernimmt den Großteil der Logik, darunter die Dokumentsuche, Adapter für Inhaltsquellen und Markdown-Erweiterungen.
Fumadocs UI
Das Standarddesign von Fumadocs sorgt für ein klares Erscheinungsbild von Dokumentationsseiten und interaktiven Komponenten.
Inhaltsquelle
Die Quelle Ihrer Inhalte. Das kann ein CMS sein oder eine lokale Datenebene wie Fumadocs MDX, die offizielle Inhaltsquelle.
Fumadocs CLI
Ein Kommandozeilenwerkzeug, mit dem Sie UI-Komponenten installieren und Abläufe automatisieren. Es hilft beim Anpassen von Layouts.
Möchten Sie mehr erfahren?
Lesen Sie unsere ausführliche Einführung Was ist Fumadocs.
Begriffe
Markdown/MDX: Markdown ist eine Auszeichnungssprache für formatierten Text. Fumadocs unterstützt Markdown und MDX, eine Obermenge von Markdown, ohne zusätzliche Einrichtung.
Grundkenntnisse des Next.js App Router sind nicht zwingend, erleichtern aber weitere Anpassungen.
Automatische Installation
Sie benötigen mindestens Node.js 18. Beachten Sie, dass Node.js 23.1 Probleme mit dem Production-Build von Next.js haben kann.
npm create fumadocs-appDie Einrichtung fragt Folgendes ab:
- das React.js-Framework (die Dokumentation ist nur für Next.js geschrieben),
- die zu verwendende Inhaltsquelle.
Anschließend ist eine neue Fumadocs-App angelegt. Sie können direkt loslegen.
Sie haben bereits eine Codebasis?
Folgen Sie der Anleitung zur manuellen Installation.
Viel Erfolg
Legen Sie Ihre erste MDX-Datei im Ordner docs an.
---
title: Hello World
---
## Yo what's upStarten Sie die App im Entwicklungsmodus und öffnen Sie http://localhost:3000/docs.
npm run devHäufige Fragen
Einige Fragen, die häufig auftreten.
Fumadocs aktualisieren
Aktualisieren Sie Fumadocs, wenn Probleme auftreten oder Sie neue Funktionen ausprobieren möchten:
pnpm update -i -r --latestWeiterführendes
Neu hier? Kein Problem, Fragen sind willkommen.
Wenn etwas unklar ist, geben Sie uns bitte Rückmeldung in der GitHub Discussion.
Inhalte schreiben
Wenn Sie Dokumentation verfassen, lesen Sie bitte:
Markdown
Fumadocs bietet zusätzliche Funktionen zum Verfassen von Inhalten.
Navigation
So passen Sie Navigationslinks und Einträge in der Seitenleiste an.
Routing
So strukturieren Sie Inhalte.
Komponenten
Alle verfügbaren Komponenten, mit denen Sie Ihre Dokumentation erweitern