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.
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.
- 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
- Versioned Docs — Sync default docs from
mainand pinned versions from refs such ascraft-5 - 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
.mdlink stripping - Sidebar Navigation — Driven by
.sidebar.jsonwith 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.jsonvia dropdown - Prev/Next Navigation — Automatic previous and next page links
- Frontend Templates — Installable starter templates for source listing, docs, and changelog pages
- 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
composer require lindemannrock/craft-docs-managerphp craft plugin/install docs-managerddev composer require lindemannrock/craft-docs-managerddev craft plugin/install docs-managerFull documentation is available in the docs folder.
- Documentation: https://github.com/LindemannRock/craft-docs-manager
- Issues: https://github.com/LindemannRock/craft-docs-manager/issues
- Email: support@lindemannrock.com
This plugin is licensed under the Craft License. See LICENSE.md for details.
Developed by LindemannRock