Fumadocs

Fumadocs ist ein Dokumentations-Framework, das Entwicklern hilft, professionelle Dokumentationsseiten mit React und Next.js zu erstellen. Im Gegensatz zu herkömmlichen Dokumentationstools bietet es vollständige Kontrolle über Inhalt und Design, während die komplexen Teile automatisch gehandhabt werden.

Es unterstützt das Schreiben von Inhalten in Markdown und MDX, was bedeutet, dass Sie einfache Textformatierungen verwenden oder interaktive React-Komponenten hinzufügen können. Das Framework beinhaltet eine integrierte Suche, Syntaxhervorhebung und wunderschöne vorgefertigte Designs. Es funktioniert auch mit jeder Inhaltsquelle, egal ob Sie Ihre Dokumentation in Dateien, einer Datenbank oder einem Content-Management-System speichern.

Fumadocs besteht aus drei Teilen: einer Content-Schicht zur Verwaltung Ihrer Dokumentation, einer Kernbibliothek für Funktionen wie Suche und einer UI-Bibliothek für ansprechende Komponenten. Sie können genau das verwenden, was Sie benötigen.

Der Einstieg mit Fumadocs ist einfach. Hier sind die Schritte:

• Installieren Sie das Framework, indem Sie den Befehl npm create fumadocs-app in Ihrem Terminal ausführen. Wählen Sie bei Aufforderung Ihr bevorzugtes React-Framework und Ihre Inhaltsquelle aus.

• Schreiben Sie Ihre Inhalte in MDX-Dateien im Ordner docs. Verwenden Sie einfache Markdown-Syntax mit der Möglichkeit, React-Komponenten für interaktive Elemente hinzuzufügen.

• Passen Sie das Erscheinungsbild an mit Tailwind CSS an. Sie können Farben, Layouts und Stile ändern, um Ihre Marke anzupassen, ohne ein neues System lernen zu müssen.

• Fügen Sie eine Suchfunktion hinzu, indem Sie Orama oder Algolia Search mit nur wenigen Codezeilen verbinden. Das Framework übernimmt den Rest automatisch.

• Verwenden Sie das CLI-Tool, um interaktive Komponenten wie Tabs, Callouts und Codeblöcke mit dem Befehl npx @fumadocs/cli add hinzuzufügen.

• Veröffentlichen Sie Ihre Seite auf Vercel, Netlify oder einem Hosting-Dienst, der Next.js-Anwendungen unterstützt.

• Kostenloses und Open-Source-Framework

• Funktioniert mit Next.js, React Router und anderen React-Frameworks

• Inhalte in Markdown und MDX schreiben

• Eingebaute Suche mit Orama- und Algolia-Unterstützung

• OpenAPI-Dokumentationsgenerator

• TypeScript Twoslash-Integration

• Schöne vorgefertigte UI-Komponenten

• Kommandozeilen-Tool für einfache Einrichtung

• Syntaxhervorhebung mit Shiki

• Hochgradig anpassbar mit Tailwind CSS