Mit Apple iPadOS können Sie jede Webseite in eine Web-App umwandeln, die in einer eigenen Instanz von Safari mit einem eigenen Symbol auf Ihrem Startbildschirm ausgeführt wird. Mit dieser Funktion können Sie eine App für das cloudbasierte CMS erstellen.
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.
DocStatic bietet eine Reihe von Skripten, die Ihnen beim Erstellen, Bereitstellen und Veröffentlichen Ihrer Website helfen.
Ein Markdown-Dokument erstellen.
Standardmäßig wird docStatic auf GitHub Pages bereitgestellt. Weitere Optionen finden Sie unter Bereitstellung in der Docusaurus-Dokumentation.
Eine Einführung in die docStatic-Dokumentation.
Eine der beiden Kernkomponenten von docStatic ist das CMS (die andere ist das SSG). Bislang haben Sie wahrscheinlich nur die lokale Version verwendet, die über die Befehlszeile mit „yarn dev“ aufgerufen wird. docStatic unterstützt jedoch auch zwei Möglichkeiten, eine gehostete Version des CMS zu verwenden.
Willkommen! Diese Anleitung führt Sie durch die erstmalige Einrichtung von docStatic.
DocStatic ist eine moderne Dokumentationsplattform, die die Lücke zwischen Autoren und Entwicklern schließt und Ihnen dabei hilft, Online-Dokumentationen zu erstellen, die Ihre Benutzer lieben werden.
Wiki sidebar generation and category index document conventions.
Ein Model Context Protocol (MCP) Server, der KI-Assistenten über den TinaCMS GraphQL-Endpunkt strukturierten Zugriff auf Ihre docStatic-Dokumentation ermöglicht.
docStatic enthält einen integrierten Model Context Protocol (MCP) Server, der KI-Assistenten den Zugriff auf Ihre Dokumentation und deren Verständnis ermöglicht. Dies bietet intelligente Unterstützung bei der Inhaltsbearbeitung, Suche und Analyse.
DocStatic verwendet GitHub Actions, um Workflow-Benachrichtigungen zu versenden. Beispiele für Überprüfungs- und Übersetzungsbenachrichtigungen finden Sie im Ordner „.github/workflows/“. Um diese zu aktivieren, sind einige Konfigurationen in GitHub erforderlich. Sie können sie auch als Ausgangspunkt für die Entwicklung Ihrer eigenen benutzerdefinierten Benachrichtigungen verwenden.
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.
Vale ist ein Kommandozeilen-Prose-Linter, der Ihre Dokumentation anhand konfigurierbarer Stilregeln überprüft. Er integriert sich gut mit Markdown- und MDX-Dateien und ist damit eine natürliche Ergänzung für docStatic-Projekte.
Die Komponente Verwandte Themen schlägt automatisch verwandte Inhalte basierend auf gemeinsamen Taxonomie-Tags vor. Sie analysiert die Tags der aktuellen Seite und findet andere Dokumente mit ähnlichen Tags, die dann als kuratierte Empfehlungsliste angezeigt werden.
Standardmäßig ist docStatic für die Verwendung der Lunr-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.
DocStatic unterstützt die Suchmaschinenoptimierung auf verschiedene Weise:
Statische Assets sind Nicht-Code-Dateien, die direkt in die Build-Ausgabe kopiert werden. Dazu gehören Bilder, Stylesheets, Favicons, Schriftarten usw.
Eine der Funktionen, die Autoren, die mit Docs-as-Code arbeiten, am meisten vermissen, ist eine gute Rechtschreib-, Grammatik- und Stilprüfung. Standardmäßig wird die Rechtschreibprüfung von Ihrem Webbrowser oder Ihrer integrierten Entwicklungsumgebung bereitgestellt. Dies mag für einfache Websites ausreichend sein, aber wenn Sie etwas Fortgeschritteneres benötigen, brauchen Sie einen speziellen Grammatikprüfer.
Erstellung und Anwendung einer Informationsarchitektur in docStatic.
Upgrading Node.js modules.
Claude Code ist die KI-gestützte CLI von Anthropic. In diesem Projekt wird es als Entwicklungsassistent für eine bestimmte Reihe von Aufgaben eingesetzt. Es wurde nicht verwendet, um die Architektur von docStatic zu entwerfen oder zu entwickeln.
Der Kern des statischen Website-Generators bietet keine eigenen Funktionen. Alle Funktionen werden an einzelne Plugins delegiert: die Dokumentationsfunktion wird vom Dokumentations-Plugin bereitgestellt; die Blog-Funktion wird vom Blog-Plugin bereitgestellt; oder einzelne Seiten werden vom Seiten-Plugin bereitgestellt.