kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-09-15 08:27:37 +00:00
Code Issues Projects Releases Wiki Activity

Added [module] shortcut

Browse Source 
[module] in elements.html get replaced by the modules path.
This commit is contained in:
Paul-Vincent Roll
2016-01-28 11:13:27 +01:00
parent 7247ffae72
commit 01ee51e027
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
modules/README.md
View File

@@ -2,18 +2,18 @@ MagicMirror
===========
##Modules
A module has to contain four files: main.js, style.css, elements.html and include.php
A module has to contain four files: `main.js`, `style.css`, `elements.html` and `include.php`.
Other files can be loaded from within those.
### include.php
If you happen to need any other css or js file from remote host or a local file you can add it in include.php.
If you happen to need any other css or js file from remote host or a local file you can add it in `include.php`.
It will be loaded before the plugins main javascript, the plugins css and the plugins elements.
Local files starting without http or https will be loaded from the root of the module folder.
If you have a file called test.js in your module just add test.js if you have the same file but in a folder called js inside your module folder add js/test.js. Same is valid for css files. Remote files will be loaded normally from the remote host, no need to specify anything.
Local files starting without `http` or `https` will be loaded from the `root` of the module folder.
If you have a file called `test.js` in your module just add `test.js` if you have the same file but in a folder called `js` inside your module folder add `js/test.js`. Same is valid for css files. Remote files will be loaded normally from the remote host, no need to specify anything.
### elements.html
Put your custom divs and other html elements in this file (don't include any body or header tags)
Put your custom divs and other html elements in this file (don't include any body or header tags). Any refrence of `[module]` will be replaced with the path to the modules root. `[module]/img/test.png` becomes `modules/name_of_module/img/test.png`.
### main.js
Your plugins JavaScript.