Skip to content

Commit f111ded

Browse files
khasselkhassel
authored
update master with stuff from develop (#406)
1 parent 795f8cd commit f111ded

9 files changed

Lines changed: 341 additions & 382 deletions

File tree

‎.github/workflows/pr-check.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
uses: actions/checkout@v7
2323

2424
- name: Install Node.js
25-
uses: actions/setup-node@v6
25+
uses: actions/setup-node@v7
2626
with:
2727
node-version: current
2828

‎.vitepress/config.mts‎

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,6 @@ export default defineConfig({
66
description: "The open source modular smart mirror platform.",
77
lang: "en",
88
ignoreDeadLinks: "localhostLinks",
9-
head: [
10-
[
11-
"script",
12-
{
13-
async: "",
14-
src: "https://www.googletagmanager.com/gtag/js?id=UA-1219071-59",
15-
},
16-
],
17-
[
18-
"script",
19-
{},
20-
`window.dataLayer = window.dataLayer || [];
21-
function gtag(){dataLayer.push(arguments);}
22-
gtag('js', new Date());
23-
gtag('config', 'TAG_ID');`,
24-
],
25-
],
269
sitemap: {
2710
hostname: "https://docs.magicmirror.builders/",
2811
},
@@ -59,12 +42,12 @@ export default defineConfig({
5942
collapsed: false,
6043
items: [
6144
{ text: "Introduction", link: "/" },
62-
{ text: "Requirements", link: "/getting-started/requirements.md" },
45+
{ text: "Requirements", link: "/getting-started/requirements" },
6346
{
6447
text: "Installation & Usage",
65-
link: "/getting-started/installation.md",
48+
link: "/getting-started/installation",
6649
},
67-
{ text: "Upgrade Guide", link: "/getting-started/upgrade-guide.md" },
50+
{ text: "Upgrade Guide", link: "/getting-started/upgrade-guide" },
6851
],
6952
},
7053
{
@@ -142,12 +125,12 @@ export default defineConfig({
142125
text: "Core Development",
143126
collapsed: true,
144127
items: [
145-
{ text: "Introduction", link: "/core-development/introduction.md" },
128+
{ text: "Introduction", link: "/core-development/introduction" },
146129
{
147130
text: "Testing",
148-
link: "/core-development/testing.md",
131+
link: "/core-development/testing",
149132
},
150-
{ text: "Debugging", link: "/core-development/debugging.md" },
133+
{ text: "Debugging", link: "/core-development/debugging" },
151134
],
152135
},
153136
{

‎configuration/introduction.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
<!-- prettier-ignore -->
1313
```js
14-
let config = {
14+
const config = {
1515
modules: [
1616
{
1717
module: "clock",
@@ -169,7 +169,7 @@ Variables must be inserted as `${MY_VARIABLE}`, examples:
169169
`config.js`:
170170

171171
```js
172-
let config = {
172+
const config = {
173173
address: "${MY_ADDRESS}",
174174
port: ${MY_PORT},
175175
useHttps: ${MY_HTTPS},
@@ -182,7 +182,7 @@ would be translated to
182182

183183
<!-- prettier-ignore -->
184184
```js
185-
let config = {
185+
const config = {
186186
address: "localhost",
187187
port: 8080,
188188
useHttps: false,
@@ -233,7 +233,7 @@ You have two 1920x1080 monitors set up in the Pi as sitting next to each other:
233233
To move the pi to the second monitor, use this:
234234

235235
```js
236-
let config = {
236+
const config = {
237237
electronOptions: { x: 1920 },
238238
...
239239
```
@@ -267,7 +267,7 @@ node --run start
267267
Configuration file 1 (config.js):
268268
269269
```js
270-
let config = {
270+
const config = {
271271
address: "0.0.0.0", // Can be whatever you set as your original.
272272
port: 8080, // Must be different than the other configuration file.
273273
ipWhitelist: [], // Can be whatever you set as your original.
@@ -288,7 +288,7 @@ if (typeof module !== "undefined") {
288288
Configuration file 2 (config2.js):
289289
290290
```js
291-
let config = {
291+
const config = {
292292
electronOptions: { x: 1920 },
293293
address: "0.0.0.0", // can be whatever you set as your original.
294294
port: 8081, // Must be different than the other configuration file.
@@ -317,7 +317,7 @@ them from the config.js file.
317317
`config.js`:
318318
319319
```js
320-
let config = {
320+
const config = {
321321
address: "0.0.0.0",
322322
port: 8080,
323323
ipWhitelist: [],

‎configuration/secrets.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ including all secrets, and send it somewhere else.
5454
You have to add new parameters in `config.js`:
5555

5656
```js
57-
let config = {
57+
const config = {
5858
...
5959
hideConfigSecrets: true,
6060
...
@@ -73,7 +73,7 @@ In this example the 2 parameters are set with 2 normal environment variables
7373
`STRAVA_CLIENT_ID` and `STRAVA_API_KEY`:
7474

7575
```js
76-
let config = {
76+
const config = {
7777
...
7878
hideConfigSecrets: true,
7979
...
@@ -123,7 +123,7 @@ token in the URL.
123123
Example:
124124

125125
```js
126-
let config = {
126+
const config = {
127127
...
128128
hideConfigSecrets: true,
129129
cors: "allowWhitelist",

‎core-development/debugging.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This mode monitors files specified in your `config.js` under the `watchTargets`
4444
property:
4545

4646
```js
47-
let config = {
47+
const config = {
4848
watchTargets: [
4949
"config/config.js",
5050
"config/custom.css",
@@ -91,7 +91,7 @@ Debug logging is disabled by default, and can be very verbose. It can be enabled
9191
in the _config/config.js_ file by adding `"DEBUG"` to the `logLevel` key:
9292

9393
```js
94-
let config = {
94+
const config = {
9595
// ...
9696
logLevel: ["INFO", "LOG", "WARN", "ERROR", "DEBUG"], // Add "DEBUG" for even more logging
9797
// ...

‎getting-started/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Sample Configuration below
146146
[and link to full configuration options](/configuration/introduction)
147147

148148
```js
149-
let config = {
149+
const config = {
150150
address: "0.0.0.0", // default is "localhost"
151151
port: 8080, // default
152152
ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:172.17.0.1"], // default -- need to add your IP here

‎modules/configuration.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ see [configuration](/configuration/introduction) for more information.
1212
| `header` | To display a header text above the module, add the header property. This field is optional. |
1313
| `hiddenOnStartup` | Set module as being hidden on startup. This field is optional. |
1414
| `disabled` | Set disabled to `true` to skip creating the module. This field is optional. |
15-
| `configDeepMerge` | Allow to merge with internal configuration in deep (Array and/with object). This field is optional (on developer choice generally). |
15+
| `configDeepMerge` | By default `config` is merged with the module defaults only at the top level. Set to `true` to also merge nested objects recursively (arrays are always replaced). Whether it's useful depends on the module, so check its documentation. Optional, defaults to `false`. |
1616
| `animateIn` | Special animate name when a module appears (see below) This field is optional. |
1717
| `animateOut` | Special animates name when a module should hide (see below) This field is optional. |
1818
| `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
1919

2020
## Example
2121

2222
```js
23-
let config = {
23+
const config = {
2424
modules: [
2525
{
2626
module: "clock",

0 commit comments

Comments
 (0)