xyd

xyd ist ein Dokumentations-Framework, mit dem Sie professionelle Dokumentations-Websites erstellen können, ohne sich mit komplexen Tools herumschlagen zu müssen. Es bietet sechs wunderschöne integrierte Themes, die Sie sofort verwenden können, oder Sie können jeden Teil an Ihre Marke anpassen. Das Framework generiert automatisch Dokumentationen aus Ihren OpenAPI-, GraphQL-, TypeScript- und React-Code-Spezifikationen.

Im Gegensatz zu anderen Dokumentationstools enthält xyd von Anfang an alles, was Sie brauchen. Sie erhalten eine Volltextsuche mit intelligenten Vorschlägen, integrierte Analysen zur Nachverfolgung der Nutzung Ihrer Dokumentation, Live-Chat-Integration und sogar A/B-Testfunktionen. Der Entwicklungsserver startet sofort mit Hot Reload, sodass Sie Änderungen sofort sehen. Entwickelt von Entwicklern für Entwickler, nimmt xyd Ihnen die langweiligen Teile der Dokumentationserstellung ab, damit Sie sich auf das Schreiben großartiger Inhalte konzentrieren können.

Der Einstieg mit xyd ist unkompliziert. Hier sind die Schritte zur Erstellung Ihrer Dokumentation:

• Installieren Sie xyd global mit dem Befehl bun add -g xyd-js oder Ihrem bevorzugten Paketmanager. Sie benötigen Node.js Version 22.12 oder höher auf Ihrem Computer.

• Führen Sie xyd in Ihrem Projektordner aus, um den Entwicklungsserver zu starten. Er startet sofort mit Hot Reload, sodass Sie Ihre Änderungen sofort sehen, ohne neu starten zu müssen.

• Wählen Sie aus sechs integrierten Themes oder erstellen Sie Ihr eigenes individuelles Design. Jedes Theme bietet einen anderen Stil und ein anderes Layout, um Ihren Projektanforderungen gerecht zu werden.

• Schreiben Sie Ihre Dokumentation mit dem Rich-Content-Framework, das interaktive Komponenten, Live-Code-Beispiele und dynamische Elemente unterstützt, die Ihre Dokumentation ansprechender machen.

• Für API-Dokumentationen zeigen Sie xyd einfach auf Ihre OpenAPI-, GraphQL-, TypeScript- oder React-Spezifikationen, und es generiert automatisch eine ansprechende Dokumentation.

• Führen Sie xyd build aus, wenn Sie bereit sind, statische Dateien zur Bereitstellung auf einem Hosting-Service zu erstellen.

• Sechs wunderschöne integrierte Designs verfügbar

• Automatische API-Dokumentation aus OpenAPI, GraphQL, TypeScript, React

• Hot-Reload-Entwicklungsserver ohne Konfiguration

• Volle Anpassung aller Komponenten und Layouts

• Umfangreiches Plugin-Ökosystem für Suche, Analyse, Chat

• Interaktive Codebeispiele und dynamische Inhalte

• Integrierte Analyse- und A/B-Test-Unterstützung

• Blitzschnelle Volltext-Suchfunktion

• Open Source und komplett kostenlos

• Migrationswerkzeuge von anderen Frameworks