doc: added "dependencies" section for plugins
Massimo Melina committed
Feb 14, 2024 at 09:15 UTC
d3814b23a651b67e7fffdf9335a38496bb2440ea
1 file changed
+8
dev-plugins.md
+8
@@ -321,6 +321,14 @@ These files have a special meaning:
321
- `custom.html` file, that works exactly like the main `custom.html`. Even when same section is specified
322
by 2 (or more) files, both contents are appended.
323
324
+## Dependencies
325
+
326
+You run vanilla javascript here, in the backend and/or in the browser, so the tools you have for dependencies
327
+are the ones provided by node.js and/or the browser.
328
+If you use a library for the browser, you'll have to keep it in the "public" folder, as the browser must be able to load it.
329
+If you want to use a module for node.js, just include "node_modules" folder (not in "public" folder).
330
+You can decide if you want to use some building system/transpiler, but you'll have to set it up yourself.
331
+
332
## Publish your plug-in
333
334
Suggested method for publishing is to have a dedicated repository on GitHub, with topic `hfs-plugin`.