doc: node modules for plugins
Massimo Melina committed
Feb 26, 2026 at 20:11 UTC
ecc899a424899620d1730768a3b2d26bfa152773
1 file changed
+5
-1
dev-plugins.md
+5
-1
@@ -346,7 +346,7 @@ The `api` object you get as parameter of the `init` contains the following:
346
```js
347
const { watchLoad } = api.require('./watchLoad')
348
```
349
- You *should* try to keep this kind of behavior at its minimum, as name of sources and elements can change, and your
349
+ You *should* try to keep this kind of behavior at its minimum, as the name of sources and elements can change, and your
350
plugin can become incompatible with future versions.
351
If you need something for your plugin that's not covered by `api`, you can test it with this method, but you should
352
then discuss it on the forum because an addition to `api` is your best option for making a future-proof plugin.
@@ -897,6 +897,10 @@ These files have a special meaning:
897
- `custom.html` file, that works exactly like the main `custom.html`. Even when same section is specified
898
by 2 (or more) files, both contents are appended.
899
900
+## Node modules
901
+
902
+You can run `npm install` inside your plugin's folder. This creates a `node_modules` directory that will be included as part of your plugin package.
903
+
904
## Storage
905
906
Plugins that need to store generated data persistently should put all the files in the "storage" folder that is