Mit Apple iPadOS können Sie jede beliebige Webseite in eine Web-App umwandeln, die in einer eigenen Safari-Instanz mit einem eigenen Symbol auf Ihrem Startbildschirm ausgeführt wird. Diese Funktion können Sie nutzen, um eine App für das cloudbasierte CMS zu 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.
Using CALS tables in docStatic, including merged cells, column widths and border control.
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.
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.
Ein Markdown-Dokument erstellen.
Standardmäßig wird docStatic auf bereitgestellt. Weitere Optionen finden Sie unter 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 Kluft zwischen Autoren und Entwicklern überbrückt und Ihnen dabei hilft, Online-Dokumentationen zu erstellen, die Ihre Nutzer begeistern 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 verfügt über einen integrierten Model Context Protocol (MCP)-Server, der es KI-Assistenten ermöglicht, auf Ihre Dokumentation zuzugreifen und diese zu verstehen. Dies bietet intelligente Unterstützung bei der Bearbeitung, Suche und Analyse von Inhalten.
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.
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 -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 Dateien, die keinen Code enthalten und direkt in die Build-Ausgabe kopiert werden. Dazu gehören Bilder, Stylesheets, Favicons, Schriftarten und so weiter.
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.
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 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.