edward/MMM-pages
1
0
Fork 0
mirror of https://github.com/edward-shen/MMM-pages.git synced 2024-11-24 11:14:29 -08:00
Code Issues Projects Releases Packages Wiki Activity

Update readme.md

Browse source
This commit is contained in:
sam detweiler 2023-11-22 09:22:52 -06:00 committed by GitHub
parent 4f06e4559f
commit 2f5ac7666a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
readme.md
View file

@ -57,7 +57,9 @@ To display what page you're on, I'd highly recommend checking out my
## Using the module ## Using the module
To use this module, add it to the modules array in the `config/config.js` file. To use this module, add it to the modules array in the `config/config.js` file.
Note: module names used in the following example are fictitious. this approach uses the module names as the page organization technique, as the modulename is added as a css class in the MM page content. Note: module names used in the following example are fictitious.
this approach uses the module names as the page organization technique, as the modulename is added as a css class in the MM page content.
Because the modulename is used, this approach does not support multiple instances of the same module with data Because the modulename is used, this approach does not support multiple instances of the same module with data
on different pages. (like your calendar on page 1, and someone elses on page 2) on different pages. (like your calendar on page 1, and someone elses on page 2)
@ -100,7 +102,7 @@ modules: [
} }
] ]
``` ```
and then at each module, add a classes: property to indicate the page(s) this is supposed to appear on and then at each module, add a classes: property to indicate the page(s) this module is supposed to appear on
``` ```
{ {
module:"newsfeed", module:"newsfeed",
@ -117,7 +119,7 @@ and then at each module, add a classes: property to indicate the page(s) this is
``` ```
etc etc
if u want a modules content on multiple pages the classes has those page names if u want a modules content on multiple pages the classes would list those page names
``` ```
{ {
module:"newsfeed", module:"newsfeed",
@ -133,7 +135,7 @@ if u want a modules content on multiple pages the classes has those page names
}, },
{ {
module:"compliments", module:"compliments",
classes:"page1 page2", classes:"page1 page2", // this module appears on multiple pages
} }
``` ```