Guides
Learn about the most important docStatic concepts.
Creating pages
Seiten unterscheiden sich von anderen Inhaltstypen dadurch, dass sie als einmalige, eigenständige Inhalte gedacht sind, z. B. als Showcase, Spielplatz oder Support-Seite. Sie können React-Komponenten und Markdown enthalten. Beachten Sie, dass Seiten keine Seitenleisten haben.
Dokumentation
2 Einträge
Blog
Mit der Blog-Funktion können Sie Artikel mit Zeitstempel erstellen.
Wikis
Eine Wiki-Seite ist eine Web- bzw. Dokumentationsseite, die für die Zusammenarbeit konzipiert ist. Sie lässt sich innerhalb weniger Minuten erstellen und bearbeiten und wird häufig sowohl für den internen Wissensaustausch im Team als auch für öffentlich zugängliche Hilfeinhalte genutzt.
Markdown-Funktionen
21 Einträge
Styling and layout
Eine docStatic-Website ist eine einseitige React-Anwendung. Sie können sie genauso gestalten wie React-Apps.
Static assets
Statische Assets sind Dateien, die keinen Code enthalten und direkt in die Build-Ausgabe kopiert werden. Dazu gehören Bilder, Stylesheets, Favicons, Schriftarten und so weiter.
Search
Standardmäßig ist docStatic für die Verwendung der -Suche konfiguriert. Der Hauptvorteil dieser Lösung besteht darin, dass sie kostenlos ist. Der größte Nachteil ist, dass der gesamte Suchindex auf den Browser des Benutzers heruntergeladen wird. Je größer Ihre Website ist, desto langsamer wird sie.
Chatbot
docStatic kann Ihrer Website einen KI-Chatbot hinzufügen, der Fragen zu Ihrer Dokumentation beantwortet. Standardmäßig läuft dieser vollständig im Browser des Besuchers unter Verwendung von WebLLM (über WebGPU), sodass kein externer Dienst, kein API-Schlüssel und kein Server erforderlich sind. Das gleiche Widget kann auch auf einen kostenpflichtigen Anbieter verweisen, den Sie selbst hosten, ohne dass sich für die Besucher etwas ändert.
Browser support
Mit docStatic können Sie die Liste der unterstützten Browser über eine Browsersliste-Konfiguration definieren. In der Regel sollten Websites auf jedem modernen Browser gut funktionieren.
Search engine optimization (SEO)
docStatic unterstützt die Suchmaschinenoptimierung auf verschiedene Weise:
Using plugins
Der Kern des Static-Site-Generators bietet selbst keine Funktionen. Alle Funktionen werden an einzelne Plugins delegiert: die Dokumentationsfunktion wird vom bereitgestellt; die Blog-Funktion, die vom bereitgestellt wird; oder einzelne Seiten, die vom bereitgestellt werden.
Deployment
Standardmäßig wird docStatic auf bereitgestellt. Weitere Optionen finden Sie unter in der Docusaurus-Dokumentation.
Internationalization
Der statische Website-Generator bietet Unterstützung für die Internationalisierung (). Ausführliche Informationen finden Sie unter in der Docusaurus-Dokumentation.
CLI
docStatic stellt eine Reihe von Skripten bereit, die Ihnen beim Erstellen, Bereitstellen und Deployen Ihrer Website helfen. Diese sind im Abschnitt scripts der Datei package.json Ihrer Website definiert, die die maßgebliche Liste darstellt – führen Sie npm run ohne Argumente aus, um die Skripte anzuzeigen, über die Ihre Website tatsächlich verfügt.