edward/MMM-pages
1
0
Fork 0
mirror of https://github.com/edward-shen/MMM-pages.git synced 2025-04-18 19:28:19 -07:00
Code Issues Projects Releases Packages Wiki Activity

Fix typos

Browse source
This commit is contained in:
Kristjan ESPERANTO 2024-12-14 12:55:18 +01:00
parent d6bcfd4742
commit bccc069a6b
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,7 +2,7 @@
## Project status ## Project status
This project is **mature** and in maintence mode only. New features or fixes This project is **mature** and in maintenance mode only. New features or fixes
will not be actively made. If you'd like to see a feature or fix, please will not be actively made. If you'd like to see a feature or fix, please
create a pull request. create a pull request.
@ -118,14 +118,14 @@ Instead of using the module name, you can also use a class name for each page. T
}, },
``` ```
You have to add the class name to the config of the module you want to show on a specific page. You can even add more than one class name to show a module istance on multiple pages. You have to add the class name to the config of the module you want to show on a specific page. You can even add more than one class name to show a module instance on multiple pages.
```js ```js
{ // newsfeed on page 1 { // newsfeed on page 1
module:"newsfeed", module:"newsfeed",
classes:"page1", classes:"page1",
position: "...", position: "...",
conig: { config: {
... ...
} }
}, },
@ -145,7 +145,7 @@ You have to add the class name to the config of the module you want to show on a
... ...
} }
}, },
{ // this compliments istance appears on page 1 and 3 { // this compliments instance appears on page 1 and 3
module:"compliments", module:"compliments",
classes:"page1 page3", classes:"page1 page3",
position: "...", position: "...",
@ -163,7 +163,7 @@ You have to add the class name to the config of the module you want to show on a
| `modules` | `[[String...]...]` | `[]` | A 2D String array of what each module should be on which page. Note that all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. | | `modules` | `[[String...]...]` | `[]` | A 2D String array of what each module should be on which page. Note that all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. |
| `fixed` | `[String...]` | `["MMM-page-indicator"]` | Which modules should show up all the time. | | `fixed` | `[String...]` | `["MMM-page-indicator"]` | Which modules should show up all the time. |
| `excludes` | *NA* | *NA* | **Deprecated**. Use `fixed` instead. | | `excludes` | *NA* | *NA* | **Deprecated**. Use `fixed` instead. |
| `hiddenPages` | `{String: [String...]...}` | `{}` | An Object defining special `hiddenPages` which are not available on the normal page rotation and only accassible via a notification. Modules defined in `fixed` are ignored and need to be also added if you wish to have them on any hidden page. | | `hiddenPages` | `{String: [String...]...}` | `{}` | An Object defining special `hiddenPages` which are not available on the normal page rotation and only accessible via a notification. Modules defined in `fixed` are ignored and need to be also added if you wish to have them on any hidden page. |
| `animationTime` | `int` | `1000` | Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). | | `animationTime` | `int` | `1000` | Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). |
| `rotationTime` | `int` | `0` | Time, in milliseconds, between automatic page changes. | | `rotationTime` | `int` | `0` | Time, in milliseconds, between automatic page changes. |
| `rotationDelay` | `int` | `10000` | Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. | | `rotationDelay` | `int` | `10000` | Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. |
@ -236,9 +236,9 @@ max pages have a way to determine which page to start on.
### Hidden pages ### Hidden pages
The idea behind hidden pages is to be able to create special "modes" which The idea behind hidden pages is to be able to create special "modes" which
are totally configurable by the user and are seperated from the "normal" MM² operation. are totally configurable by the user and are separated from the "normal" MM² operation.
Some examples would be a "guest", "admin" or "screensaver" mode, where only very Some examples would be a "guest", "admin" or "screensaver" mode, where only very
specific modules are shown and you do not want to have them in your normal page roation. specific modules are shown and you do not want to have them in your normal page rotation.
These hidden pages are only accessible via notifications, so you need to send them from These hidden pages are only accessible via notifications, so you need to send them from
other modules. Examples integrations could be with touch, bots or voice commands. other modules. Examples integrations could be with touch, bots or voice commands.
@ -275,7 +275,7 @@ See also FAQ below.
## Developer commands ## Developer commands
If you want to contribute to this poject, pleases use the following commands to maintain code quality: If you want to contribute to this project, pleases use the following commands to maintain code quality:
- `npm install` - Install development dependencies for linting. - `npm install` - Install development dependencies for linting.
- `npm run lint` - Run linting checks. - `npm run lint` - Run linting checks.