Introduction

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.

Sie bietet gleichzeitig die besten Funktionen von Komponenten-Content-Management-Systemen und Docs-as-Code-Lösungen für Online-Dokumentationen. Mit DocStatic kann jeder in Ihrem Team Ihre Dokumente erstellen und bearbeiten, ohne den Arbeitsablauf Ihrer Entwickler zu beeinträchtigen.

Funktionen

DocStatic ist eine Weiterentwicklung von Tinasaurus, einem Open-Source-Projekt auf Basis von React, das einen statischen Website-Generator (Docusaurus) mit einem headless content management system (TinaCMS) kombiniert. Es umfasst:

• Eine benutzerfreundliche Bearbeitungsoberfläche für Markdown-, MDX-, JSON- und YAML-Inhalte.
• Integration in bestehende Git- und CI/CD-Workflows.
• Eingebettete MDX-Komponenten.
• Medienmanager mit Unterstützung für Medienanbieter von Drittanbietern.
• Bearbeitung in der Cloud (keine lokale Einrichtung erforderlich).

Einfache Inhaltsverwaltung

Die Standard-Sammlungen von DocStatic umfassen einige der fortgeschritteneren Autorenfunktionen, die Sie von einem CCMS erwarten würden.

Der Rich-Text-Editor erleichtert das Hinzufügen von:

• Bedingtem Text, Snippets und Variablensätzen für die Wiederverwendung von Inhalten
• Taxonomien
• Glossarbegriffen
• Code-Blöcken, Kommentaren, ausblendbaren Details, Abbildungen, Fußnoten und Registerkarten. Diese sind als Vorlagen verfügbar, die Sie in eine Inhaltsdatei einfügen können.

Das CMS verwendet ein GraphQL-Schema, um die Form Ihrer Inhalte als eine Reihe von Sammlungen zu beschreiben.

Git-gestützt

Die Quellcodeverwaltung, Automatisierung und optional auch die Veröffentlichung werden über GitHub verwaltet. Beim Bearbeiten von Dateien mit dem Rich-Text-Editor führt TinaCMS entweder beim Speichern einen Commit durch oder speichert direkt in der Datei, wenn lokal gearbeitet wird. Git bleibt die Quelle der Wahrheit für das gesamte Team.

Die Repository-Struktur ist den Docusaurus-Standardeinstellungen sehr ähnlich, jedoch mit einigen Änderungen, die für die Integration mit TinaCMS erforderlich sind.

Vorkonfigurierte Plugins

DocStatic ist mit Plugins vorkonfiguriert, die Funktionen wie KaTeX-Gleichungen, Lunr-Suche, Mermaid-Diagramme und OpenAPI-Dokumente unterstützen. Es gibt eine integrierte Unterstützung für Internationalisierung (i18n). Mehrsprachige Rechtschreib-, Grammatik- und optional auch Stilprüfungen werden von LanguageTool über Browser- und IDE-Plugins bereitgestellt.

React-basiert

Der Inhalt wird im MDX-Format gespeichert – einer Erweiterung von Markdown, die benutzerdefinierte React-Komponenten für Funktionen wie Admonitions unterstützt. Diese Komponenten sind universell verfügbar und müssen nicht in einzelnen Dateien deklariert werden. Bei der lokalen Arbeit kompiliert der Dev-Server die Seiten sofort neu, wenn Sie Ihre Änderungen speichern.

Vollständig dokumentiert

Entwickler finden alle Informationen, die sie zur Konfiguration und Inbetriebnahme von DocStatic benötigen, in der Dokumentation von Docusaurus und TinaCMS. Diese Informationen werden hier nicht dupliziert, um zu vermeiden, dass sie veraltet sind. Stattdessen konzentriert sich die DocStatic-Dokumentation auf die Verwendung des CMS.