Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-11-10 16:05:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated plugin docs

Browse Source
This commit is contained in:
Julian Lam
2014-05-02 02:03:01 -04:00
parent 6f0e749b60
commit d112d62a3f
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/plugins/create.rst
View File

@@ -31,7 +31,9 @@ Each plugin package contains a configuration file called ``plugin.json``. Here i
"description": "Your plugin's description",
"url": "Absolute URL to your plugin or a Github repository",
"library": "./my-plugin.js",
"staticDir": "/assets",
"staticDirs": {
"images": "public/images"
},
"less": [
"assets/style.less"
],
@@ -45,7 +47,9 @@ The ``id`` property is a unique name that identifies the plugin.
The ``library`` property is a relative path to the library in your package. It is automatically loaded by NodeBB (if the plugin is activated).
The ``staticDir`` property is a path (relative to your plugin's root) to a directory that NodeBB will expose to the public at the route ``/plugins/{YOUR-PLUGIN-ID}``.
The ``staticDirs`` property is an object hash that maps out paths (relative to your plugin's root) to a directory that NodeBB will expose to the public at the route ``/plugins/{YOUR-PLUGIN-ID}``.
* e.g. The ``staticDirs`` hash in the sample configuration maps ``/plugins/my-plugin/images`` to ``/path/to/your/plugin/public/images``
The ``less`` property contains an array of paths (relative to your plugin's directory), that will be precompiled into the CSS served by NodeBB.