lindemannrock/craft-docs-manager

Parse and sync documentation from markdown files to Craft CMS

5.0.0 2026-05-21 20:17 UTC

Requires

• php: >=8.2
• craftcms/cms: ^5.0.0
• league/commonmark: ^2.4
• lindemannrock/craft-code-highlighter: ^5.0
• lindemannrock/craft-logging-library: ^5.0
• lindemannrock/craft-plugin-base: ^5.0
• symfony/yaml: ^7.0

Requires (Dev)

• craftcms/ecs: dev-main
• craftcms/phpstan: dev-main
• phpunit/phpunit: ^11.0

proprietary

• Bilal Hary Lindemann

• documentation
• parser
• cms
• markdown
• Craft
• craftcms
• craft-plugin
• docs-manager

README

Sync and serve documentation for plugins and themes from markdown files on your Craft CMS website. Supports local filesystem and GitHub API sources with automatic scheduled syncing.

⚠️ Pre-Release

This plugin is in active development and not yet available on the Craft Plugin Store. Features and APIs may change before the initial public release.

Features

• Dual Source Support — Sync from local filesystem or GitHub API per-source
• Plugin & Theme Sources — Each source has a kind (plugin or theme) for filtering
• Automatic Sync — Scheduled sync via Craft queue (hourly, daily, weekly, monthly)
• Custom Pages — CP-managed pages (FAQ, features, pricing, support) attached to a source alongside synced docs
• Code Extraction — Auto-generate docs skeleton from PHP source (Settings, permissions, commands, events, Twig variables)
• CommonMark Parser — Full markdown parsing with syntax highlighting, anchor generation, and .md link stripping
• Sidebar Navigation — Driven by .sidebar.json with section grouping
• On This Page — Auto-generated heading anchors for in-page navigation
• Changelog Parsing — Syncs and parses CHANGELOG.md with CommonMark rendering
• Version Detection — Reads source versions from composer.json / CHANGELOG / Packagist / git tags
• Quick Add — Auto-discover sources with docs/index.json via dropdown
• Prev/Next Navigation — Automatic previous and next page links
• Frontend Templates — Installable starter templates for source listing, docs, and changelog pages

Requirements

• Craft CMS 5.0+
• PHP 8.2+
• Logging Library 5.0+ — installed automatically; enable in CP to activate log viewing
• Code Highlighter 5.0+ — installed automatically; enable in CP to activate syntax highlighting

Installation

Via Composer

composer require lindemannrock/craft-docs-manager

php craft plugin/install docs-manager

Using DDEV

ddev composer require lindemannrock/craft-docs-manager

ddev craft plugin/install docs-manager

Documentation

Full documentation is available in the docs folder.

Support

• Documentation: https://github.com/LindemannRock/craft-docs-manager
• Issues: https://github.com/LindemannRock/craft-docs-manager/issues
• Email: [e-mail]

License

This plugin is licensed under the Craft License. See LICENSE.md for details.

Developed by LindemannRock