Advanced guides
Dieser Abschnitt behandelt die fortgeschritteneren Funktionen von docStatic, einschließlich der Integrationen:
Front Matter CMS
Beim Erstellen von Inhalten in einer IDE wie stehen die Funktionen des CMS nicht zur Verfügung. In einem typischen Workflow erstellen oder bearbeiten Entwickler Inhalte, indem sie die MDX-Datei direkt in der IDE ändern, während Autoren die Inhalte im CMS bereinigen und mit Tags versehen. Wenn der Entwickler vergisst, ein Datum für die letzte Änderung anzugeben, müssen Sie die Dateieigenschaften überprüfen, um diese Information zu erhalten. Es gibt jedoch ein leichtgewichtiges CMS, das als Plugin namens Front Matter verfügbar ist. Das docStatic-Repository enthält ein Beispiel für eine Front Matter-Konfiguration. Weitere Informationen finden Sie in der Front Matter-Dokumentation.
Gehostetes CMS
1 Eintrag
Notifications
docStatic nutzt , um Workflow-Benachrichtigungen zu versenden. Beispielbenachrichtigungen für die Überprüfung und Übersetzung sind im Ordner .github/workflows/ enthalten. Um diese zu aktivieren, sind einige Konfigurationen in GitHub erforderlich. Sie können diese auch als Ausgangspunkt nutzen, um Ihre eigenen benutzerdefinierten Benachrichtigungen zu entwickeln.
MCP Server Integration
1 Eintrag
OpenAPI reference docs
docStatic verwendet docusaurus-plugin-openapi-docs, um API-Referenzdokumentation aus einer OpenAPI-Spezifikation zu generieren. Das Plugin liest eine Spezifikationsdatei und schreibt eine Reihe von MDX-Dateien in Ihren docs/-Baum, die Docusaurus dann als normale Seiten erstellt.
Style checking
Eine der Funktionen, die Autoren, die mit „Docs-as-Code“ arbeiten, am meisten vermissen, ist ein guter Rechtschreib-, Grammatik- und Stilprüfer. Standardmäßig wird die Rechtschreibprüfung von Ihrem Webbrowser oder Ihrer integrierten Entwicklungsumgebung bereitgestellt. Dies mag für einfache Websites ausreichen, doch wenn Sie etwas Fortgeschritteneres benötigen, brauchen Sie einen speziellen Grammatikprüfer.
Entwickler, die daran interessiert sind, die Funktionalität von docStatic zu erweitern, sollten die Anleitungen und Anleitungen für Fortgeschrittene in der Docusaurus-Dokumentation lesen.