Skip to content

Commit d92d47d

Browse files
rejascrazyscotbugsounetKristjanESPERANTOWallysWellies
authored
Vuepress v2 (#279)
* weather.md: update for recent changes (#230) * add updates feature configuration (#234) * Update calendar.md (#236) * updateOnFetch feature Docs (#235) * Minor changes (#238) * Minor changes - wording - Magic Mirror -> MagicMirror - format * sh -> shell * Update compliments docs page (#242) Add documentation for the specialDayUnique config option * Cleanup formatting (#247) * bump prettier * run prettier * UK Met Office Documentation Fix (#253) * Update weather.md Updated documentation for MetOffice update * Update weather.md * add doc for new compliments(#3481) and support custom positions (#3518) (#254) * add doc for new compliments(#3481) and support custom positions (#3518) * fix typo * update compliments, and module position info (#255) * add doc for new compliments(#3481) and support custom positions (#3518) * fix typo * Added docs for new notification `MODULE_DOM_UPDATED` (#262) * Bump send and express (#260) Bumps [send](https://github.com/pillarjs/send) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together. Updates `send` from 0.18.0 to 0.19.0 - [Release notes](https://github.com/pillarjs/send/releases) - [Changelog](https://github.com/pillarjs/send/blob/master/HISTORY.md) - [Commits](pillarjs/send@0.18.0...0.19.0) Updates `express` from 4.20.0 to 4.21.0 - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/4.21.0/History.md) - [Commits](expressjs/express@4.20.0...4.21.0) --- updated-dependencies: - dependency-name: send dependency-type: indirect - dependency-name: express dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Added docs for new notification - . Fixes #261 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update Windows section and add Wayland section (#265) According to the changes in PR MagicMirrorOrg/MagicMirror#3594. * add clarification for nextDaysRelative and showEndsOnlyWithDuration, … (#268) * add clarification for nextDaysRelative and showEndsOnlyWithDuration, only apply to full day events * add emphasis for PREVENT on showEndsOnlyWithDuration * electron-rebuild -> @electron/rebuild (#271) electron-rebuild has been deprecated. * update doc for #3630 (#273) * fix typos, add doc for calendar FullDateEnd format usage, add new env for fetch timeout (#277) * fix typos, add doc for calendar FullDateEnd format usage, add new env variable for fetch timeout * bump deps * lint docs * fix typo --------- Co-authored-by: veeck <[email protected]> * prepare release 2.31.0 * Upgrade to Vuepress2 (#214) * Start migrating to v2 * Make CarbonAds work again * Remove dead files and cleanups * Bump vue * Bump to rc2 * Bump to rc8 * Bump to rc9 * Add logo, remove contributor list * Bump to rc11 * Fix menu * Bump to rec12 * Bump to rc14 * bump dependencies * bump dependencies * bump to rc19 --------- Co-authored-by: veeck <[email protected]> * fix and update dependencies * update package-lock.json * Final cleanups (#287) * remove yarn lock * add discord link * bump deps * add alt text --------- Co-authored-by: veeck <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Ross Younger <[email protected]> Co-authored-by: Bugsounet - Cédric <[email protected]> Co-authored-by: Kristjan ESPERANTO <[email protected]> Co-authored-by: WallysWellies <[email protected]> Co-authored-by: jargordon <[email protected]> Co-authored-by: Karsten Hassel <[email protected]> Co-authored-by: sam detweiler <[email protected]> Co-authored-by: Ryan Williams <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: veeck <[email protected]>
1 parent f57b8e1 commit d92d47d

File tree

16 files changed

+4594
-28155
lines changed

16 files changed

+4594
-28155
lines changed

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
.DS_Store
22
.idea/
33
node_modules/
4+
5+
.vuepress/.cache
6+
.vuepress/.temp
7+
.vuepress/dist

‎.vuepress/.gitignore‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.vuepress/client.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { defineClientConfig } from 'vuepress/client';
2+
import Layout from './layouts/Layout.vue';
3+
4+
export default defineClientConfig({
5+
layouts: {
6+
Layout,
7+
},
8+
})

‎.vuepress/components/CarbonAds.vue‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<script>
2+
import {h} from 'vue';
3+
4+
export default {
5+
watch: {
6+
'$route'(to, from) {
7+
if (
8+
to.path !== from.path
9+
// Only reload if the ad has been loaded
10+
// otherwise it's possible that the script is appended but
11+
// the ads are not loaded yet. This would result in duplicated ads.
12+
&& this.$el.querySelector('#carbonads')
13+
) {
14+
this.$el.innerHTML = '';
15+
this.load();
16+
}
17+
},
18+
},
19+
mounted() {
20+
this.load();
21+
},
22+
methods: {
23+
load() {
24+
const s = document.createElement('script');
25+
s.id = '_carbonads_js';
26+
s.src = `//cdn.carbonads.com/carbon.js?serve=CK7IC23N&placement=magicmirror`;
27+
this.$el.appendChild(s);
28+
},
29+
},
30+
render() {
31+
return h('div', {class: 'carbon-ads'});
32+
},
33+
};
34+
</script>
35+
36+
<style lang="scss">
37+
.sidebar {
38+
.carbon-ads {
39+
a {
40+
display: block;
41+
}
42+
}
43+
}
44+
.carbon-ads {
45+
min-height: 130px;
46+
padding: 1.5rem 1.5rem 0;
47+
margin-bottom: -0.5rem;
48+
font-size: 0.75rem;
49+
border-bottom: 1px solid var(--c-border);
50+
a {
51+
color: #444;
52+
font-weight: normal;
53+
display: inline;
54+
}
55+
.carbon-img {
56+
float: left;
57+
margin-right: 1rem;
58+
border: 1px solid var(--c-border);
59+
img {
60+
display: block;
61+
}
62+
}
63+
.carbon-poweredby {
64+
color: #999;
65+
display: block;
66+
margin-top: 0.5em;
67+
}
68+
}
69+
.dark {
70+
a.carbon-text {
71+
color: var(--c-text-light);
72+
}
73+
}
74+
@media (max-width: 719px) {
75+
.carbon-ads .carbon-img img {
76+
width: 100px;
77+
height: 77px;
78+
}
79+
}
80+
</style>

‎.vuepress/config.js‎

Lines changed: 70 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,95 @@
1-
module.exports = {
2-
title: "MagicMirror² Documentation",
1+
import { defaultTheme } from '@vuepress/theme-default';
2+
import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics';
3+
import { docsearchPlugin } from '@vuepress/plugin-docsearch';
4+
import { viteBundler } from '@vuepress/bundler-vite';
5+
6+
export default {
7+
title: "MagicMirror² Docs",
38
description: "The open source modular smart mirror platform.",
4-
themeConfig: {
5-
// logo: '/mm.png',
6-
algolia: {
7-
appId: "U3QOOOGLZR",
8-
apiKey: "96d207343bbb5e45068a1e3c8d141bb4",
9-
indexName: "docs-magicmirror-builders",
10-
},
11-
nav: [
9+
bundler: viteBundler({}),
10+
theme: defaultTheme({
11+
contributors: false,
12+
docsRepo: "MagicMirrorOrg/MagicMirror-Documentation",
13+
docsBranch: "master",
14+
editLinkText: "Help us improve this page!",
15+
logo: 'logo.png',
16+
navbar: [
1217
{ text: "Donate", link: "https://magicmirror.builders/donate" },
18+
{ text: "Discord", link: "https://discord.gg/J5BAtvx" },
1319
{ text: "Forum", link: "https://forum.magicmirror.builders" },
1420
],
21+
repo: "MagicMirrorOrg/MagicMirror",
22+
repoLabel: "GitHub",
1523
sidebar: [
1624
{
17-
title: "Getting Started",
18-
collapsable: true,
25+
text: "Getting Started",
26+
collapsible: true,
1927
children: [
2028
"/",
21-
"getting-started/requirements",
22-
"getting-started/installation",
23-
"getting-started/upgrade-guide",
29+
"/getting-started/requirements.md",
30+
"/getting-started/installation.md",
31+
"/getting-started/upgrade-guide",
2432
],
2533
},
2634
{
27-
title: "Configuration",
28-
collapsable: true,
35+
text: "Configuration",
36+
collapsible: true,
2937
children: [
30-
"configuration/introduction",
31-
"configuration/autostart",
32-
"configuration/raspberry",
38+
"/configuration/introduction",
39+
"/configuration/autostart",
40+
"/configuration/raspberry",
3341
],
3442
},
3543
{
36-
title: "Modules",
37-
collapsable: true,
44+
text: "Modules",
45+
collapsible: true,
3846
children: [
39-
"modules/introduction",
40-
"modules/configuration",
47+
"/modules/introduction",
48+
"/modules/configuration",
4149
{
42-
title: "Default Modules",
43-
collapsable: false,
50+
text: "Default Modules",
51+
collapsible: false,
4452
children: [
45-
"modules/alert",
46-
"modules/calendar",
47-
"modules/clock",
48-
"modules/compliments",
49-
"modules/helloworld",
50-
"modules/newsfeed",
51-
"modules/updatenotification",
52-
"modules/weather",
53+
"/modules/alert",
54+
"/modules/calendar",
55+
"/modules/clock",
56+
"/modules/compliments",
57+
"/modules/helloworld",
58+
"/modules/newsfeed",
59+
"/modules/updatenotification",
60+
"/modules/weather",
5361
],
5462
},
55-
"modules/customcss",
56-
"modules/animate"
63+
"/modules/animate"
5764
],
5865
},
5966
{
60-
title: "Module Development",
61-
collapsable: true,
67+
text: "Module Development",
68+
collapsible: true,
6269
children: [
63-
"development/introduction.md",
64-
"development/core-module-file.md",
65-
"development/node-helper.md",
66-
"development/helper-methods.md",
67-
"development/logger.md",
68-
"development/notifications.md",
69-
"development/weather-provider.md",
70-
"development/documentation.md",
70+
"/development/introduction.md",
71+
"/development/core-module-file.md",
72+
"/development/node-helper.md",
73+
"/development/helper-methods.md",
74+
"/development/logger.md",
75+
"/development/notifications.md",
76+
"/development/weather-provider.md",
77+
"/development/documentation.md",
7178
],
7279
},
7380
{
74-
title: "About",
75-
collapsable: true,
81+
text: "About",
82+
collapsible: true,
7683
children: [
77-
"about/manifesto",
78-
"about/contributing",
79-
"about/donate",
80-
"about/support",
81-
"about/LICENSE",
84+
"/about/manifesto",
85+
"/about/contributing",
86+
"/about/donate",
87+
"/about/support",
88+
"/about/LICENSE",
8289
],
8390
},
8491
],
85-
repo: "MagicMirrorOrg/MagicMirror",
86-
repoLabel: "GitHub",
87-
88-
docsRepo: "MagicMirrorOrg/MagicMirror-Documentation",
89-
docsBranch: "master",
90-
editLinks: true,
91-
editLinkText: "Help us improve this page!",
92-
lastUpdated: "Updated",
93-
},
92+
}),
9493
markdown: {
9594
toc: { includeLevel: [2, 3, 4] },
9695
},
@@ -100,13 +99,14 @@ module.exports = {
10099
},
101100
},
102101
plugins: [
103-
["@vuepress/back-to-top"],
104-
['check-md'],
105-
[
106-
"@vuepress/google-analytics",
107-
{
108-
ga: "UA-1219071-59", // UA-00000000-0
109-
},
110-
],
102+
googleAnalyticsPlugin({
103+
id: "UA-1219071-59",
104+
}),
105+
docsearchPlugin({
106+
apiKey: "96d207343bbb5e45068a1e3c8d141bb4",
107+
appId: "U3QOOOGLZR",
108+
indexName: "docs-magicmirror-builders",
109+
}),
111110
],
112111
};
112+

‎.vuepress/layouts/Layout.vue‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<script setup>
2+
import ParentLayout from '@vuepress/theme-default/layouts/Layout.vue'
3+
import CarbonAds from "../components/CarbonAds.vue";
4+
</script>
5+
6+
<template>
7+
<ParentLayout>
8+
<template #sidebar-top>
9+
<slot name="sidebar-top" />
10+
<CarbonAds/>
11+
</template>
12+
</ParentLayout>
13+
</template>

‎.vuepress/public/logo.png‎

6.78 KB
Loading

‎.vuepress/styles/index.scss‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:root {
2+
scroll-behavior: smooth;
3+
}

‎.vuepress/styles/palette.styl‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.vuepress/theme/components/CarbonAds.vue‎

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)