PHPackages                             moinframe/kirby-paradocs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. moinframe/kirby-paradocs

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

moinframe/kirby-paradocs
========================

Auto-generate beautiful documentation pages using markdown

1.0.1(1mo ago)1681MITPHP

Since Jun 23Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/moinframe/kirby-paradocs)[ Packagist](https://packagist.org/packages/moinframe/kirby-paradocs)[ Docs](https://github.com/moinframe/kirby-paradocs)[ RSS](/packages/moinframe-kirby-paradocs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (8)Dependencies (10)Versions (9)Used By (0)

[![Kirby Paradocs](kirby-paradocs.jpg)](kirby-paradocs.jpg)

Kirby Paradocs
==============

[](#kirby-paradocs)

Auto-generate beautiful documentation pages from markdown files within your Kirby plugins.

Features
--------

[](#features)

- **Auto-Discovery**: Automatically scans installed plugins for documentation
- **Beautiful Frontend**: Clean, responsive documentation interface inspired by Kirby Docs
- **Markdown Processing**: Full markdown support with frontmatter, alerts, and code blocks
- **Syntax Highlighting**: Enhanced code highlighting with Phiki integration
- **Access Control**: Optional authentication to restrict documentation access
- **Smart Caching**: Built-in caching for optimal performance
- **Plugin Filtering**: Safelist specific plugins for documentation inclusion

How It Works
------------

[](#how-it-works)

Kirby Paradocs transforms your plugin directories into a unified documentation site. When you visit `/docs` (configurable), the plugin scans all installed Kirby plugins looking for documentation files. It processes README.md files, `/docs` directories, and optional `.paradocs.json` configuration files to build a comprehensive documentation hierarchy.

Each plugin's documentation is automatically organized with support for nested directories, index pages, and rich markdown content. The plugin processes markdown and provides syntax highlighting for code examples. All documentation is rendered through customizable Kirby templates and snippets.

The system respects your plugin's existing documentation structure while providing a polished interface for end users. Whether you're documenting internal tools or public plugins, Paradocs creates a quick and good looking documentation experience.

Quick Start
-----------

[](#quick-start)

### Download

[](#download)

Download and copy this repository to `/site/plugins/kirby-paradocs`.

### Composer

[](#composer)

```
composer require moinframe/kirby-paradocs

# With enhanced syntax highlighting
composer require moinframe/kirby-paradocs phiki/phiki
```

### Git submodule

[](#git-submodule)

```
git submodule add https://github.com/moinframe/kirby-paradocs.git site/plugins/kirby-paradocs
```

### Visit your documentation:

[](#visit-your-documentation)

Navigate to `/docs` in your Kirby site to view the generated documentation. You have to be logged in to the Kirby Panel if not otherwise configured.

Documentation
-------------

[](#documentation)

- [Getting started](docs/01-getting-started/index.md) - Complete setup instructions
- [Writing docs](docs/02-write-docs/index.md) - How to write documentation
- [Customization](docs/02-write-docs/index.md) - Customize to fit your site
- [Custom Processors](docs/02-write-docs/index.md) - Extend the system with custom processors

Requirements
------------

[](#requirements)

- **Kirby CMS:** 4.6+
- **PHP:** 8.3+
- **Optional:** [Phiki](https://github.com/phikiphp/phiki) for enhanced syntax highlighting

Support
-------

[](#support)

- **Documentation:** [Website](https://moinfra.me/docs/moinframe-paradocs)
- **Issues:** [GitHub Issues](https://github.com/moinframe/kirby-paradocs/issues)
- **Source Code:** [GitHub Repository](https://github.com/moinframe/kirby-paradocs)

License
-------

[](#license)

[MIT License](LICENSE.md)

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance89

Actively maintained with recent releases

Popularity19

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~39 days

Recently: every ~65 days

Total

8

Last Release

55d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bf9d09693dffe919aa833f7808c30813768f221bde1d76fe55b2adbf9130bfdc?d=identicon)[moinframe](/maintainers/moinframe)

---

Top Contributors

[![JuKra00](https://avatars.githubusercontent.com/u/2682834?v=4)](https://github.com/JuKra00 "JuKra00 (57 commits)")

---

Tags

kirby-cmskirby-pluginkirby4kirby5

###  Code Quality

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/moinframe-kirby-paradocs/health.svg)

```
[![Health](https://phpackages.com/badges/moinframe-kirby-paradocs/health.svg)](https://phpackages.com/packages/moinframe-kirby-paradocs)
```

###  Alternatives

[distantnative/retour-for-kirby

Manage redirects and track 404s right from the Kirby CMS Panel

14689.4k1](/packages/distantnative-retour-for-kirby)[arnoson/kirby-vite

Vite helper for Kirby CMS

9759.2k3](/packages/arnoson-kirby-vite)[oblik/kirby-link-field

Kirby 4 field for all types of links.

7650.6k2](/packages/oblik-kirby-link-field)[belugadigital/kirby-navigation

Kirby 5 field for hierarchical menus with drag & drop level indentation.

8713.4k](/packages/belugadigital-kirby-navigation)[rasteiner/k3-whenquery

Conditionally show fields and sections. Better.

6717.8k](/packages/rasteiner-k3-whenquery)[fabianmichael/kirby-meta

Your all-in-one powerhouse for any SEO and metadata needs imaginable.

6910.7k1](/packages/fabianmichael-kirby-meta)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)