Markdown documentation sync

Name: Markdown documentation sync
Availability: InStock
Author: valkyrianlabs

Syncs Markdown documentation with Payload CMS using Git.

Community 3 152/wk MIT v1.0.5

Installation

$ pnpm add @valkyrianlabs/payload-markdown-docs

About

The @valkyrianlabs/payload-markdown-docs plugin facilitates the integration of Markdown documentation into Payload CMS. This plugin connects a markdown documentation directory with your Payload application, allowing seamless syncing, validation, and rendering of documentation directly from markdown files. Users can generate documentation with AI assistance while maintaining control over the content, enabling teams to keep documentation up to date as development progresses. This plugin offers features such as support for GitHub Actions for automated syncing, validation of Markdown files, and integration with Next.js for rendering. It's built for teams that prefer a documentation workflow closely tied to their existing codebase, allowing the documentation to evolve alongside the application. Configuration options include enabling draft syncing and controlling write permissions, ensuring flexibility in documentation management. The plugin is designed to work together with the payload-markdown library for improved documentation presentation and control while allowing for custom setups through a clear configuration API.