Write documentation

Kirby Paradocs supports plugins that have a README.md file by default. You can also add a more complex documentation structure in a folder named docs in the root of your plugin. This folder can contain any number of markdown files and folders.

Add your own documentation#

To add your own documentation, create a folder in site/plugins and add a index.php and a README.md file.

// file path: site/plugins/your-plugin/index.php

Kirby::plugin('your-name/your-plugin', []);

# My Plugin
This is my plugin documentation

The documentation for your plugin will be accessible at
https://yourdomain.com/docs/your-name-your-plugin.

File ordering and naming#

Documentation files and folders use numbered prefixes to control their order. For example, 01-getting-started.md will appear before 02-configuration.md. The number prefix is stripped from the URL slug, so 01-getting-started becomes getting-started in the URL.

An index.md file inside a subdirectory serves as the parent page content for that directory. For example, docs/02-guides/index.md provides the content shown when a user visits the "guides" section, while other files in that folder become child pages.

Configuration#

To change the default configuration, create a .paradocs.json file in the root of your plugin. This file should contain a JSON object with the following properties:

{
  // The title of your plugin
  "title": "My Plugin",
  // The description of your plugin
  "description": "This is my plugin documentation",
  // The folder name where your documentation is located
  "root": "my-docs-folder",
  // Logo file placed in the plugin's assets folder (e.g. site/plugins/your-plugin/assets/logo.svg)
  "logo" : "logo.svg"
}