Docusaurus
Docusaurus ist ein kostenloses Open-Source-Tool, das Ihnen hilft, schnell schöne Dokumentationswebsites mit React und Markdown zu erstellen.
Was ist Docusaurus?
Docusaurus ist ein statischer Seitengenerator, der mit React und Node.js entwickelt wurde. Er nimmt Ihre Markdown-Dateien und erstellt eine vollständige Dokumentationswebsite mit allen Funktionen, die Benutzer erwarten. Im Gegensatz zum Erstellen einer Website von Grund auf übernimmt Docusaurus die schwierigen Aufgaben für Sie.
Das Tool verwendet MDX, was bedeutet, dass Sie interaktive React-Komponenten direkt in Ihre Markdown-Dateien einfügen können. Dadurch wird Ihre Dokumentation ansprechender, ohne zusätzlichen Aufwand. Es verfügt über eine integrierte Suche, die von Algolia unterstützt wird, Versionsverwaltung für verschiedene Produktversionen und Unterstützung für über 70 Sprachen durch Übersetzungswerkzeuge.
Da es statische Dateien erstellt, lädt Ihre Dokumentation schnell und kann überall gehostet werden. Die Websites funktionieren hervorragend auf mobilen Geräten und entsprechen modernen Webstandards für Geschwindigkeit und Barrierefreiheit.
So verwenden Sie Docusaurus
Der Einstieg mit Docusaurus ist einfach und dauert nur wenige Minuten:
Installieren Sie Node.js Version 20 oder höher auf Ihrem Computer und führen Sie dann den Setup-Befehl im Terminal aus, um eine neue Website zu erstellen.
Schreiben Sie Ihre Dokumentation in Markdown-Dateien im Ordner „docs“. Jede Datei wird zu einer Seite auf Ihrer Website.
Passen Sie das Aussehen an, indem Sie die Konfigurationsdatei bearbeiten. Sie können Farben ändern, Ihr Logo hinzufügen und Navigationsmenüs einrichten.
Verwenden Sie den lokalen Vorschau-Befehl, um Änderungen sofort im Browser zu sehen, während Sie arbeiten.
Fügen Sie Blogbeiträge hinzu, indem Sie Markdown-Dateien mit Datumsangaben im Dateinamen im Ordner „blog“ erstellen.
Wenn Sie bereit sind zu veröffentlichen, führen Sie den Build-Befehl aus, um statische Dateien zu generieren, und laden Sie diese dann auf einen Webhost wie GitHub Pages, Netlify oder Vercel hoch.
Das Tool enthält ausführliche Anleitungen und eine hilfreiche Community, falls Sie Unterstützung benötigen.
Funktionen von Docusaurus
Kostenlos und Open Source mit MIT-Lizenz
Erstellt mit React und Node.js
Inhalte in Markdown und MDX schreiben
Integrierte Suche mit Algolia DocSearch
Versionsverwaltung für Produktveröffentlichungen
Unterstützung für über 70 Sprachen
Blog und Dokumentation auf einer Website
Dunkelmodus und responsives Design
Schnelle statische Seitengenerierung
Einfache Bereitstellung auf jedem Host
Docusaurus Preise
Free
Free
- Vollständiger Dokumentationsseiten-Generator
- Markdown- und MDX-Unterstützung
- Integrierte Algolia DocSearch
- Dokumentenversionierung
- Internationalisierung (70+ Sprachen)
- Blog-Funktionalität
- Unterstützung für den Dunkelmodus
- SEO-Optimierung
- Benutzerdefinierte React-Komponenten
- Pluginsystem
Docusaurus Anwendungsfälle
Wer kann von Docusaurus profitieren?
Docusaurus Repository
Auf Github ansehen| Sterne | 62,687 |
| Forks | 9,552 |
| Repository-Alter | 8 Jahren |
| Letzter Commit | 19 Tagen vor |
Häufig gestellte Fragen zu Docusaurus
Teilen Sie Ihre Erfahrung mit Docusaurus
Sehen Sie, was Benutzer über sagen Docusaurus
0 Bewertungen
Noch keine Bewertungen
Seien Sie der Erste, der bewertet Docusaurus
Docusaurus Abzeichen einbetten
Zeigen Sie Ihrer Community, dass Docusaurus auf Tool Questor vorgestellt wird. Fügen Sie diese schönen Abzeichen zu Ihrer Website, Dokumentation oder sozialen Profilen hinzu, um Glaubwürdigkeit zu steigern und mehr Traffic zu generieren.
