moinframe / kirby-paradocs
Auto-generate beautiful documentation pages using markdown
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Type:kirby-plugin
Requires
- getkirby/cms: ^4.6
- getkirby/composer-installer: ^1.1
This package is not auto-updated.
Last update: 2025-02-28 19:24:02 UTC
README
Kirby Paradocs is a plugin for Kirby CMS that allows you to create beautiful documentation pages using markdown. The plugin will scan the installed plugins in your Kirby installation and auto-generate a documentation page for each plugin.
The primary use case for this plugin is to easily provide documentation pages for your own plugins. The idea is to combine the flexibility of having the documentation in markdown inside the plugins repository itself with the ease of creating beautiful documentation pages for your users.
Features
- Automatically generates documentation pages for all installed plugins
- (Optional) user authentication to restrict access
- Provides frontend inspired by the Kirby Docs
Installation
Warning
This plugin is still in development and should be considered alpha. It will change quite a bit before it reaches a stable version.
Download
Download and copy this repository to /site/plugins/kirby-paradocs.
Composer
composer require moinframe/kirby-paradocs
Git submodule
git submodule add https://github.com/moinframe/kirby-paradocs.git site/plugins/kirby-paradocs