Markdown documentation sync

Über

Das Plugin @valkyrianlabs/payload-markdown-docs integriert Markdown-Dokumentation in Payload CMS. Es verbindet ein Markdown-Dokumentationsverzeichnis mit der Payload-Anwendung und ermöglicht die Synchronisation, Validierung und Darstellung von Dokumentationen direkt aus Markdown-Dateien. Benutzer können mithilfe von KI unterstützte Dokumentationen erstellen, während sie die Kontrolle über den Inhalt behalten, wodurch Teams die Dokumentation während des Entwicklungsprozesses aktuell halten können. Das Plugin unterstützt GitHub Actions für die automatische Synchronisation und Validierung von Markdown-Dateien sowie die Integration mit Next.js zur Darstellung. Es richtet sich an Teams, die einen Dokumentationsworkflow bevorzugen, der eng mit ihrem bestehenden Code verbunden ist, was es ermöglicht, die Dokumentation parallel zur Anwendung weiterzuentwickeln. Konfigurationsoptionen beinhalten das Aktivieren von Entwurfssynchronisation und die Kontrolle von Schreibberechtigungen, wodurch eine flexible Verwaltung der Dokumentation gewährleistet ist. Das Plugin ist darauf ausgelegt, gemeinsam mit der payload-markdown-Bibliothek zu arbeiten, um die Präsentation und Kontrolle der Dokumentation zu verbessern, während es benutzerdefinierte Konfigurationen über eine klare API ermöglicht.

Paketinformationen

Paketname

@valkyrianlabs/payload-markdown-docs

Neueste Version

1.1.0

Entpackte Größe

798 kB

Lizenz

MIT

Wöchentliche Downloads

29

Zuletzt veröffentlicht

2. Okt. 2026