Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
7e8f28f
weather.md: update for recent changes (#230)
crazyscot Jan 29, 2024
154a843
add updates feature configuration (#234)
bugsounet Mar 23, 2024
a78bd1f
Update calendar.md (#236)
bugsounet Mar 23, 2024
2ce3c94
updateOnFetch feature Docs (#235)
bugsounet Mar 23, 2024
4e451f8
Minor changes (#238)
KristjanESPERANTO Mar 30, 2024
43103c3
Merge branch 'mm-master' into mm-develop
rejas Apr 2, 2024
942936f
Merge branch 'mm-master' into mm-develop
rejas Jul 3, 2024
6b6eb2d
Update compliments docs page (#242)
WallysWellies Jul 3, 2024
87ff347
Cleanup formatting (#247)
rejas Jul 3, 2024
f642eb1
Merge branch 'mm-master' into mm-develop
rejas Jul 3, 2024
61f70b7
UK Met Office Documentation Fix (#253)
jargordon Jul 8, 2024
89b6259
Merge branch 'master' into develop
khassel Jul 11, 2024
085392a
add doc for new compliments(#3481) and support custom positions (#351…
sdetweil Aug 4, 2024
6f61f0c
update compliments, and module position info (#255)
sdetweil Aug 31, 2024
ff262af
Merge branch 'mm-master' into mm-develop
rejas Sep 10, 2024
73fae2b
Added docs for new notification `MODULE_DOM_UPDATED` (#262)
ryan-d-williams Sep 19, 2024
eac07b0
Merge branch 'master' into develop
khassel Sep 30, 2024
3f661a4
Update Windows section and add Wayland section (#265)
KristjanESPERANTO Oct 25, 2024
1d53e8d
add clarification for nextDaysRelative and showEndsOnlyWithDuration, …
sdetweil Oct 27, 2024
eff6c0d
electron-rebuild -> @electron/rebuild (#271)
KristjanESPERANTO Nov 9, 2024
57499ae
update doc for #3630 (#273)
sdetweil Nov 12, 2024
d547306
Merge branch 'mm_master' into mm_develop
Dec 11, 2024
9f756ef
fix typos, add doc for calendar FullDateEnd format usage, add new env…
sdetweil Dec 30, 2024
98e9f94
Merge branch 'master' into develop
rejas Dec 30, 2024
90da8ee
Merge branch 'mm_master' into mm_develop
Jan 1, 2025
8567162
prepare release 2.31.0
Jan 1, 2025
a107053
Upgrade to Vuepress2 (#214)
rejas Jan 1, 2025
4f01306
Merge branch 'master' into develop
Jan 8, 2025
cbbe318
fix and update dependencies
Jan 8, 2025
5c0f8bb
update package-lock.json
khassel Jan 8, 2025
f22acb3
Merge branch 'mm_master' into mm_develop
Jan 9, 2025
44a2e0c
Final cleanups (#287)
rejas Feb 15, 2025
eae559f
Merge branch 'mm_master' into mm_develop
Feb 23, 2025
cee5e92
newsfeed: add new properties for feeds (#294)
khassel Mar 23, 2025
e66a168
[updatenotification] Added option to iterate over modules directory i…
khassel Mar 31, 2025
f31e6a8
add info for clock css and deprecated property, clarify property use …
sdetweil Mar 31, 2025
e761761
Update weather.md (#281)
princemaxwell Mar 31, 2025
a8e7e92
Merge branch 'mm_master' into mm_develop
Mar 31, 2025
2a925d1
Cleanups (#297)
rejas Mar 31, 2025
7a79763
Merge branch 'mm_master' into mm_develop
Apr 1, 2025
8bfc509
Add documentation for disableNextEvent (#307)
bughaver Apr 27, 2025
0b88fff
Add documentation for disableNextEvent (#307)
bughaver Apr 27, 2025
862f15f
Update clock.md (#309)
bughaver May 16, 2025
700a405
fix compliments option table (#300)
rejas Apr 2, 2025
6c4a0ae
Bump vite from 6.1.3 to 6.1.4 (#302)
dependabot[bot] Apr 4, 2025
8858b96
replace `npm start` with `npm run start` (#304)
khassel Apr 7, 2025
58dcc7c
Bump vite from 6.1.4 to 6.1.5 (#305)
dependabot[bot] Apr 11, 2025
320bede
Update dependencies (#306)
rejas Apr 14, 2025
e873585
Bump vite from 6.2.6 to 6.2.7 (#308)
dependabot[bot] Apr 30, 2025
e13d6ea
changes after removal of dirs fonts and vendor, remove unneeded ignor…
khassel Jun 1, 2025
f635f50
docs: reword windows part and move it from "Installation" to "Usage" …
KristjanESPERANTO Jun 4, 2025
5048aae
Merge remote-tracking branch 'origin/master' into develop
khassel Jun 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions cspell.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
}
12 changes: 6 additions & 6 deletions development/core-module-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
]
Expand All @@ -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.
]
Expand Down
44 changes: 12 additions & 32 deletions getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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`.
4 changes: 2 additions & 2 deletions modules/clock.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ The following properties can be configured:
| `clockBold` | Remove the colon and bold the minutes to make a more modern look. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false` |
| `showTime` | Turn off or on the Time section. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true` |
| `showDate` | Turn off or on the Date section. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true` |
| `showWeek` | Turn off or on the Week section. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false` |
| `showSunTimes` | Turn off or on the section showing sunrise and sunset times (digital clock only). <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false` |
| `showWeek` | Turn off or on the Week section. <br><br> **Possible values:** `true`, `false` or `short` <br> **Default value:** `false` |
| `showSunTimes` | Turn off or on the section showing sunrise and sunset times (digital clock only). <br><br> **Possible values:** `true`, `false` or `disableNextEvent` <br> **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<br><br> **Possible values:** `times`, `percent`, `phase`, `both` or `false` (disable) <br> **Default value:** `false` |
| `lat` | Latitude for sun/moon calculations. <br><br> **Default value:** `47.630539` |
| `lon` | Longitude for sun/moon calculations. <br><br> **Default value:** `-122.344147` |
Expand Down