Skip to content

Commit 189db84

Browse files
rejasrejas
committed
Merge branch 'master' into develop
2 parents b284abf + 6024b4d commit 189db84

File tree

10 files changed

+99
-68
lines changed

10 files changed

+99
-68
lines changed

‎configuration/autostart.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Autostart your MagicMirror
1+
# Autostart your MagicMirror²
22

3-
The methods below describe ways to automatically start your MagicMirror on boot,
4-
and even ways to keep it running in case of a failure.
3+
The methods below describe ways to automatically start your MagicMirror² on
4+
boot, and even ways to keep it running in case of a failure.
55

66
## Using PM2
77

@@ -29,10 +29,10 @@ pm2 startup
2929

3030
PM2 will now show you a command you need to execute.
3131

32-
### Make a MagicMirror start script.
32+
### Make a MagicMirror² start script.
3333

34-
To use PM2 in combination with MagicMirror, we need to make a simple shell
35-
script. Preferable, we put this script outside the MagicMirror folder to make
34+
To use PM2 in combination with MagicMirror², we need to make a simple shell
35+
script. Preferable, we put this script outside the MagicMirror² folder to make
3636
sure it won't give us any issues if we want to upgrade the mirror.
3737

3838
```shell
@@ -54,9 +54,9 @@ shell script is executable by performing the following command:
5454
chmod +x mm.sh
5555
```
5656

57-
You are now ready to the MagicMirror using this script using PM2.
57+
You are now ready to the MagicMirror² using this script using PM2.
5858

59-
### Starting your MagicMirror with PM2
59+
### Starting your MagicMirror² with PM2
6060

6161
Simply start your mirror with the following command:
6262

@@ -66,42 +66,42 @@ pm2 start mm.sh
6666

6767
You mirror should now boot up and appear on your screen after a few seconds.
6868

69-
### Enable restarting of the MagicMirror script.
69+
### Enable restarting of the MagicMirror² script.
7070

71-
To make sure the MagicMirror restarts after rebooting, you need to save the
71+
To make sure the MagicMirror² restarts after rebooting, you need to save the
7272
current state of all scripts running via PM2. To do this, execute the following
7373
command
7474

7575
```shell
7676
pm2 save
7777
```
7878

79-
And that's all there is! You MagicMirror should now reboot after start, and
79+
And that's all there is! Your MagicMirror² should now reboot after start, and
8080
restart after any failure.
8181

82-
### Controlling you MagicMirror via PM2.
82+
### Controlling your MagicMirror² via PM2.
8383

8484
With your MagicMirror running via PM2, you have some handy tools at hand:
8585

86-
#### Restarting your MagicMirror
86+
#### Restarting your MagicMirror²
8787

8888
```shell
8989
pm2 restart mm
9090
```
9191

92-
#### Stopping your MagicMirror
92+
#### Stopping your MagicMirror²
9393

9494
```shell
9595
pm2 stop mm
9696
```
9797

98-
#### Show the MagicMirror logs
98+
#### Show the MagicMirror² logs
9999

100100
```shell
101101
pm2 logs mm
102102
```
103103

104-
#### Show the MagicMirror process information
104+
#### Show the MagicMirror² process information
105105

106106
```shell
107107
pm2 show mm
@@ -172,21 +172,21 @@ sudo systemctl start magicmirror.service
172172
sudo systemctl stop magicmirror.service
173173
```
174174

175-
#### To check the status of Magic Mirror
175+
#### To check the status of MagicMirror²
176176

177177
```
178178
sudo systemctl status magicmirror.service
179179
```
180180

181-
#### Allow autostart Magic Mirror on boot
181+
#### Allow autostart MagicMirror² on boot
182182

183183
Note: does not start immediately, need to run start command or reboot
184184

185185
```shell
186186
sudo systemctl enable magicmirror.service
187187
```
188188

189-
#### Disable autostart of Magic Mirror
189+
#### Disable autostart of MagicMirror²
190190

191191
```shell
192192
sudo systemctl disable magicmirror.service

‎development/core-module-file.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -356,10 +356,10 @@ module needs to be updated
356356

357357
**animate Object**
358358

359-
| animate | type | description |
360-
| ------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
361-
| in | String | Animate name when module will be shown (after dom update), it will use an `animateIn` type name (see [Animation Guide](../modules/animate#animatein)) |
362-
| out | String | Animate name when module will be hidden (before dom update), it will use an `animateOut` type name (see [Animation Guide](../modules/animate#animateout)) |
359+
| animate | type | description |
360+
| ------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
361+
| in | String | Animate name when module will be shown (after dom update), it will use an `animateIn` type name (see [Animation Guide](/modules/animate#animatein)) |
362+
| out | String | Animate name when module will be hidden (before dom update), it will use an `animateOut` type name (see [Animation Guide](/modules/animate#animateout)) |
363363

364364
As an example:
365365

@@ -429,7 +429,8 @@ Possible configurable options:
429429
modules identifier as the locksString: `this.identifier`. See _visibility
430430
locking_ below.
431431

432-
- `animate` - String - (_Introduced in version: 2.25.0._) Hide the module with a special animate. It will use an `animateOut` type name. All animations name are available in [Animation Guide](../modules/animate.html#animateout)
432+
- `animate` - String - (_Introduced in version: 2.25.0._) Hide the module with a special animate. It will use an
433+
`animateOut` type name. All animations name are available in [Animation Guide](/modules/animate.html#animateout)
433434

434435
::: warning Notes:
435436
- If the hide animation is cancelled, for instance because the show
@@ -463,7 +464,8 @@ Possible configurable options:
463464
- `onError(error)` - Function - If a module is hidden with other lock strings
464465
and can therefore not be shown the onError callback triggers with an error
465466
object, if specified in the options (_Introduced in version: 2.15.0_).
466-
- `animate` - String - (_Introduced in version: 2.25.0._) Show the module with a special animation. It will use an `animateIn` type name. All animations name are available in [Animation Guide](../modules/animate.html#animatein)
467+
- `animate` - String - (_Introduced in version: 2.25.0._) Show the module with a special animation. It will use an
468+
`animateIn` type name. All animations name are available in [Animation Guide](/modules/animate.html#animatein)
467469

468470
::: warning Notes:
469471
- If the show animation is canceled, for instance because the hide

‎development/introduction.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This documentation describes the way to develop your own MagicMirror² modules.
88

99
## General Advice
1010

11-
As MagicMirror has gained huge popularity, so has the number of available
11+
As MagicMirror² has gained huge popularity, so has the number of available
1212
modules. For new users and developers alike, it is very time-consuming to
1313
navigate around the various repositories in order to find out what exactly a
1414
certain modules does, how it looks and what it depends on. Unfortunately, this
@@ -24,6 +24,12 @@ information in your README file.**
2424

2525
Surely this also help you get better recognition and feedback for your work.
2626

27+
## Module name
28+
29+
We recommend the following pattern: `MMM-MyNewCoolModule`. But it is not
30+
mandatory - your module will also work with other name patterns (as long as no
31+
other module has the same name).
32+
2733
## Module structure
2834

2935
All modules are loaded in the `modules` folder. The default modules are grouped

‎development/weather-provider.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ WeatherProvider.register("yourprovider", {
2020

2121
## Weather provider methods to implement
2222

23-
::: warning IMPORTANT The weather module expects the weather data to be in
24-
metric units:
23+
::: warning IMPORTANT
24+
The weather module expects the weather data to be in metric units:
2525

2626
- `degree celsius` for temperatures
2727
- `meters per second` for wind

‎getting-started/installation.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installation & Usage
22

3-
The Magic Mirror can be installed manually or using automatic installers. At the
3+
The MagicMirror² can be installed manually or using automatic installers. At the
44
start of 2020 the decision was made to remove the automatic installer from the
55
MagicMirror² core repository and move it to a community maintained separate
66
repository. For more information about this decision, please check issue
@@ -29,7 +29,8 @@ installers can be found under:
2929
6. Start the application: `npm run start` \
3030
For **Server Only** use: `npm run server` .
3131

32-
::: warning NOTE The installation step for `npm run install-mm` will take a very
32+
::: warning NOTE
33+
The installation step for `npm run install-mm` will take a very
3334
long time, often with little or no terminal response! For the RPi3 this is
3435
**~10** minutes and for the Rpi2 **~25** minutes. Do not interrupt or you risk
3536
getting a :broken_heart: by Raspberry Jam.
@@ -127,7 +128,8 @@ In this case, you can start MagicMirror² in server only mode by manually runnin
127128
`npm run server`. This will start the server, after which you can open the
128129
application in your browser of choice. Detailed description below.
129130

130-
::: warning IMPORTANT Make sure that you whitelist the interface/ip
131+
::: warning IMPORTANT
132+
Make sure that you whitelist the interface/ip
131133
(`ipWhitelist`) in the server config where you want the client to connect to,
132134
otherwise it will not be allowed to connect to the server. You also need to set
133135
the local host `address` field to `0.0.0.0` in order for the RPi to listen on

‎getting-started/upgrade-guide.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Upgrade Guide
22

3-
::: danger WARNING Always backup your `config.js`, `custom.css` and `modules`
3+
::: danger WARNING
4+
Always backup your `config.js`, `custom.css` and `modules`
45
folder before you start the upgrade process!
56
:::
67

@@ -14,7 +15,8 @@ git pull && npm run install-mm
1415
If you changed nothing more than the config or the modules, this should work
1516
without any problems.
1617

17-
::: danger WARNING Using `git reset --hard` as described below will delete all
18+
::: danger WARNING
19+
Using `git reset --hard` as described below will delete all
1820
your changes made in the source code, so only execute this if you know what you
1921
are doing!
2022
:::

‎modules/calendar.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ The following properties can be configured:
6868
| `limitDaysNeverSkip` | If this property is set to true, every event for every day will be shown regardless of if the day on has a single full day event or not.<br><br> **Default value:** `false` |
6969
| `flipDateHeaderTitle` | This property deterines if the title for the date header in the `dateheaders` time format will align to the left or right. <br><br> **Possible values:** `true` (right) or `false` (left) <br> **Default value:** `false` (left) |
7070
| `hideTime` | If this property is set to true the time portion on relative times will be hidden.<br><br> **Default value:** `false` |
71+
| `hideDuplicates` | If this property is set to true, entries with the same title, starting and ending time will be hidden.<br><br> **Default value:** `true` |
7172
| `showTimeToday` | If this property is set to true, the event time will be displayed for same-day events even when relative display is being used.<br><br> **Default value:** `false` |
7273
| `colored`<br>_(deprecated)_ | If this property is set to true, an individual color can be set for each calendar. <br><br> **Default value:** `false` |
7374
| `coloredSymbolOnly`<br>_(deprecated)_ | If this property is set to true, an individual symbol color can be set for each calendar, not the whole line. This is only applicable when `colored` is also enabled.<br><br> **Default value:** `false` |

0 commit comments

Comments
 (0)