From 5038d124e1d3b3350c8ce11d84c113f8938dd140 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Thu, 5 Feb 2026 18:01:17 +0000 Subject: [PATCH] Theme modules: Updated docs to cover ZIP format --- dev/docs/theme-system-modules.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/dev/docs/theme-system-modules.md b/dev/docs/theme-system-modules.md index c25a60241..a52e3d25f 100644 --- a/dev/docs/theme-system-modules.md +++ b/dev/docs/theme-system-modules.md @@ -57,4 +57,12 @@ Here are some general best practices when it comes to creating modules: - Use a unique name and clear description so the user can understand the purpose of the module. - Increment the metadata version on change, keeping to [semver](https://semver.org/) to indicate compatibility of new versions. -- Where possible, prefer to [insert views before/after](logical-theme-system.md#custom-view-registration-example) instead of overriding existing views, to reduce likelihood of conflicts or update troubles. \ No newline at end of file +- Where possible, prefer to [insert views before/after](logical-theme-system.md#custom-view-registration-example) instead of overriding existing views, to reduce likelihood of conflicts or update troubles. + +### Distribution Format + +Modules are expected to be distributed as a compressed ZIP file, where the ZIP contents follow that of a module folder. +BookStack provides a `php artisan bookstack:install-module` command which allows modules to be installed from these ZIP files, either from a local path or from a web URL. +Currently, there's a hardcoded total filesize limit of 50MB for module contents installed via this method. + +There is not yet any direct update mechanism for modules, although this is something we may introduce in the future. \ No newline at end of file