kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-29 20:49:54 +00:00
Code Issues Projects Releases Wiki Activity

Language fixes README

Browse Source
This commit is contained in:
Paul-Vincent Roll 2016-01-28 11:42:43 +01:00
parent 7627fd0f38
commit 8d9d1e8d9f
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
modules/README.md
View File

@ -7,16 +7,16 @@ 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`.
It will be loaded before the plugins main javascript, the plugins css and the plugins elements.
It will be loaded before the module's main javascript, the module's css and the module's 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.
### elements.html
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`.
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 module's root. `[module]/img/test.png` for example becomes `modules/name_of_module/img/test.png`.
### main.js
Your plugins JavaScript.
Your plugin's JavaScript.
### style.css
CSS for your HTML elements.
CSS for your HTML elements. All module elements get loaded into a `div`. The `id` is the name of the module's folder, which acts as the module's name.

3
modules/test-module/style.css
View File

@ -0,0 +1,3 @@
#test-module{
}