From a1acfb4b9354c8a361bad0f11f6b7233591bec18 Mon Sep 17 00:00:00 2001 From: rafalp Date: Wed, 22 Nov 2023 21:48:40 +0100 Subject: [PATCH] Further tweak plugin guide --- dev-docs/plugins/index.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/dev-docs/plugins/index.md b/dev-docs/plugins/index.md index f95a48219c..42c8c852a4 100644 --- a/dev-docs/plugins/index.md +++ b/dev-docs/plugins/index.md @@ -5,9 +5,11 @@ Misago implements a plugin system that enables developers to customize and exten ## Plugin installation -To install a plugin, place its directory in the standard 'plugins' directory within your Misago setup. +To install a plugin, place its directory in the standard `plugins` directory within your Misago setup. -Example plugin directory must contain a valid Python package, including a `misago_plugin.py` file. For example: +Example plugin directory must contain a valid Python package with a `misago_plugin.py` file. + +This graph shows the file structure of a minimal valid plugin: ``` - minimal-plugin @@ -16,7 +18,7 @@ Example plugin directory must contain a valid Python package, including a `misag - misago_plugin.py ``` -The graph above shows the file structure of a minimal valid plugin: +Minimal plugin has: - `minimal-plugin`: a directory that contains all plugin files. - `minimal_plugin`: a Python package (and a Django application) that Misago will import.