diff --git a/cspell.config.json b/cspell.config.json index 1b356ba6..548bd655 100644 --- a/cspell.config.json +++ b/cspell.config.json @@ -33,13 +33,7 @@ "yourprovider" ], "ignorePaths": [ - "node_modules/**", - "modules/**", - "vendor/node_modules/**", - "translations/**", - "tests/mocks/**", - "tests/e2e/modules/clock_es_spec.js", - "fonts/roboto.css" + "node_modules/**" ], "dictionaries": ["node"] } diff --git a/development/core-module-file.md b/development/core-module-file.md index 0c67110f..c942ac47 100644 --- a/development/core-module-file.md +++ b/development/core-module-file.md @@ -127,15 +127,15 @@ The getScripts method is called to request any additional scripts that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.js')` method. In all cases the loader will only load a file -once. It even checks if the file is available in the default vendor folder. +once. It even checks the files defined in `js/vendor.js`. **Example:** ```javascript getScripts: function() { return [ - 'script.js', // will try to load it from the vendor folder, otherwise it will load is from the module folder. - 'moment.js', // this file is available in the vendor folder, so it doesn't need to be available in the module folder. + 'script.js', // will try to load it from the files defined in `js/vendor.js`, otherwise it will load it from the module folder. + 'moment.js', // this file is defined in `js/vendor.js`, so it doesn't need to be available in the module folder. this.file('another_file.js'), // this file will be loaded straight from the module folder. 'https://code.jquery.com/jquery-2.2.3.min.js', // this file will be loaded from the jquery servers. ] @@ -154,15 +154,15 @@ The getStyles method is called to request any additional stylesheets that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.css')` method. In all cases the loader will only load a -file once. It even checks if the file is available in the default vendor folder. +file once. It even checks the files defined in `js/vendor.js`. **Example:** ```javascript getStyles: function() { return [ - 'script.css', // will try to load it from the vendor folder, otherwise it will load is from the module folder. - 'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be available in the module folder. + 'script.css', // will try to load it from the files defined in `js/vendor.js`, otherwise it will load it from the module folder. + 'font-awesome.css', // this file is defined in `js/vendor.js`, so it doesn't need to be available in the module folder. this.file('another_file.css'), // this file will be loaded straight from the module folder. 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css', // this file will be loaded from the bootstrap cdn servers. ] diff --git a/getting-started/installation.md b/getting-started/installation.md index 7b67cf46..e9b7c9ea 100644 --- a/getting-started/installation.md +++ b/getting-started/installation.md @@ -78,38 +78,6 @@ team. Use these scripts and methods at your own risk. - We also publish the latest version of MagicMirror to the [npm-registry](https://www.npmjs.com/package/magicmirror). -## Other Operating Systems - -### Windows - -::: warning IMPORTANT - -MagicMirror² is designed to run on Linux. But with an extra step in the -installation process and a different start command, you can also run it on -Windows. Some third-party modules may not work on Windows. - -::: - -To get the software running on Windows, you have to do two things in addition to -the [steps](#manual-installation) above: - -**After step 5:** Install dependencies in the vendor and font directories: - -Powershell: - -1. `cd fonts; npm install; cd ..` -2. `cd vendor; npm install; cd ..` - -Command Prompt: - -1. `cd fonts && npm install && cd ..` -2. `cd vendor && npm install && cd ..` - -Otherwise the screen will stay black when starting the software. - -**Step 7:** In Windows you must use `npm run start:windows` instead of -`npm run start`. - ## Usage Note the following: @@ -161,3 +129,15 @@ port number of the server) If you use Wayland. Run `npm run start:wayland` instead of `npm run start` to start. + +### Windows + +::: warning IMPORTANT + +MagicMirror² is designed to run on Linux. But with a different start command, +you can also run it on Windows. Some third-party modules may not work on Windows. + +::: + +In Windows you must use `npm run start:windows` instead of +`npm run start`. diff --git a/modules/clock.md b/modules/clock.md index dcfdf409..fbe0840e 100644 --- a/modules/clock.md +++ b/modules/clock.md @@ -38,8 +38,8 @@ The following properties can be configured: | `clockBold` | Remove the colon and bold the minutes to make a more modern look.

**Possible values:** `true` or `false`
**Default value:** `false` | | `showTime` | Turn off or on the Time section.

**Possible values:** `true` or `false`
**Default value:** `true` | | `showDate` | Turn off or on the Date section.

**Possible values:** `true` or `false`
**Default value:** `true` | -| `showWeek` | Turn off or on the Week section.

**Possible values:** `true` or `false`
**Default value:** `false` | -| `showSunTimes` | Turn off or on the section showing sunrise and sunset times (digital clock only).

**Possible values:** `true` or `false`
**Default value:** `false` | +| `showWeek` | Turn off or on the Week section.

**Possible values:** `true`, `false` or `short`
**Default value:** `false` | +| `showSunTimes` | Turn off or on the section showing sunrise and sunset times (digital clock only).

**Possible values:** `true`, `false` or `disableNextEvent`
**Default value:** `false` | | `showMoonTimes` | Turn off or on the section showing moonrise and moonset times (digital clock only). Optionally display an image of lunar phase and lit percentage of the moon

**Possible values:** `times`, `percent`, `phase`, `both` or `false` (disable)
**Default value:** `false` | | `lat` | Latitude for sun/moon calculations.

**Default value:** `47.630539` | | `lon` | Longitude for sun/moon calculations.

**Default value:** `-122.344147` |