Skip to content

Commit 7c4ec7b

Browse files
rejasrejas
authored
Switch to Vitepress (#349)
1 parent 15352be commit 7c4ec7b

37 files changed

Lines changed: 2148 additions & 5254 deletions

‎.gitignore‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,5 @@
22
.idea/
33
node_modules/
44

5-
.vuepress/.cache
6-
.vuepress/.temp
7-
.vuepress/dist
5+
.vitepress/cache
6+
.vitepress/dist

‎.prettierrc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"plugins": ["prettier-plugin-vitepress"],
3+
"proseWrap": "always",
4+
"singleQuote": false,
5+
"semi": true
6+
}

‎.prettierrc.js‎

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

‎.vitepress/config.mts‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
import { defineConfig } from "vitepress";
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "MagicMirror² Docs",
6+
description: "The open source modular smart mirror platform.",
7+
lang: "en",
8+
head: [
9+
[
10+
"script",
11+
{
12+
async: "",
13+
src: "https://www.googletagmanager.com/gtag/js?id=UA-1219071-59",
14+
},
15+
],
16+
[
17+
"script",
18+
{},
19+
`window.dataLayer = window.dataLayer || [];
20+
function gtag(){dataLayer.push(arguments);}
21+
gtag('js', new Date());
22+
gtag('config', 'TAG_ID');`,
23+
],
24+
],
25+
sitemap: {
26+
hostname: "https://docs.magicmirror.builders/",
27+
},
28+
themeConfig: {
29+
// https://vitepress.dev/reference/default-theme-config
30+
carbonAds: {
31+
code: "CK7IC23N",
32+
placement: "magicmirror",
33+
},
34+
editLink: {
35+
pattern:
36+
"https://github.com/MagicMirrorOrg/MagicMirror-Documentation/blob/master/:path",
37+
text: "Help us improve this page!",
38+
},
39+
lastUpdated: {
40+
text: "Updated at",
41+
},
42+
logo: "/logo.png",
43+
nav: [
44+
{ text: "Donate", link: "https://magicmirror.builders/donate" },
45+
{ text: "Forum", link: "https://forum.magicmirror.builders" },
46+
],
47+
search: {
48+
options: {
49+
apiKey: "96d207343bbb5e45068a1e3c8d141bb4",
50+
appId: "U3QOOOGLZR",
51+
indexName: "docs-magicmirror-builders",
52+
},
53+
provider: "algolia",
54+
},
55+
sidebar: [
56+
{
57+
text: "Getting Started",
58+
collapsed: false,
59+
items: [
60+
{ text: "Introduction", link: "/" },
61+
{ text: "Requirements", link: "/getting-started/requirements.md" },
62+
{
63+
text: "Installation & Usage",
64+
link: "/getting-started/installation.md",
65+
},
66+
{ text: "Upgrade Guide", link: "/getting-started/upgrade-guide.md" },
67+
],
68+
},
69+
{
70+
text: "Configuration",
71+
collapsed: true,
72+
items: [
73+
{ text: "Introduction", link: "/configuration/introduction" },
74+
{
75+
text: "Autostart your MagicMirror²",
76+
link: "/configuration/autostart",
77+
},
78+
{ text: "Raspberry Specific", link: "/configuration/raspberry" },
79+
],
80+
},
81+
{
82+
text: "Modules",
83+
collapsed: true,
84+
items: [
85+
{ text: "Introduction", link: "/modules/introduction" },
86+
{ text: "Configuration", link: "/modules/configuration" },
87+
{
88+
text: "Default Modules",
89+
collapsed: true,
90+
items: [
91+
{ text: "Alert", link: "/modules/alert" },
92+
{ text: "Calendar", link: "/modules/calendar" },
93+
{ text: "Clock", link: "/modules/clock" },
94+
{ text: "Compliments", link: "/modules/compliments" },
95+
{ text: "Hello World", link: "/modules/helloworld" },
96+
{ text: "Newsfeed", link: "/modules/newsfeed" },
97+
{
98+
text: "Update Notification",
99+
link: "/modules/updatenotification",
100+
},
101+
{ text: "Weather", link: "/modules/weather" },
102+
],
103+
},
104+
{ text: "Animation Guide", link: "/modules/animate" },
105+
],
106+
},
107+
{
108+
text: "Module Development",
109+
collapsed: true,
110+
items: [
111+
{ text: "Introduction", link: "/module-development/introduction" },
112+
{
113+
text: "The Core module file",
114+
link: "/module-development/core-module-file",
115+
},
116+
{ text: "The Node Helper", link: "/module-development/node-helper" },
117+
{
118+
text: "Rendering Component",
119+
link: "/module-development/rendering",
120+
},
121+
{
122+
text: "MagicMirror Helper Methods",
123+
link: "/module-development/helper-methods",
124+
},
125+
{ text: "Logger", link: "/module-development/logger" },
126+
{ text: "Notifications", link: "/module-development/notifications" },
127+
{
128+
text: "Weather Module Weather Provider Development",
129+
link: "/module-development/weather-provider",
130+
},
131+
{
132+
text: "How to write good documentation",
133+
link: "/module-development/documentation",
134+
},
135+
],
136+
},
137+
{
138+
text: "Core Development",
139+
collapsed: true,
140+
items: [
141+
{ text: "Introduction", link: "/core-development/introduction.md" },
142+
{
143+
text: "Testing",
144+
link: "/core-development/testing.md",
145+
},
146+
{ text: "Debugging", link: "/core-development/debugging.md" },
147+
],
148+
},
149+
{
150+
text: "About",
151+
collapsed: true,
152+
items: [
153+
{ text: "Manifesto", link: "/about/manifesto" },
154+
{ text: "Contributing Guidelines", link: "/about/contributing" },
155+
{ text: "Donate", link: "/about/donate" },
156+
{ text: "Support", link: "/about/support" },
157+
{ text: "License", link: "/about/LICENSE" },
158+
],
159+
},
160+
],
161+
socialLinks: [
162+
{ icon: "github", link: "https://github.com/MagicMirrorOrg/MagicMirror" },
163+
{ icon: "discord", link: "https://discord.gg/J5BAtvx" },
164+
],
165+
},
166+
});

‎.vitepress/theme/index.ts‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from "vue";
3+
import type { Theme } from "vitepress";
4+
import DefaultTheme from "vitepress/theme";
5+
import "./style.css";
6+
7+
import BackToTopButton from "@miletorix/vitepress-back-to-top-button";
8+
import "@miletorix/vitepress-back-to-top-button/style.css";
9+
10+
export default {
11+
extends: DefaultTheme,
12+
Layout: () => {
13+
return h(DefaultTheme.Layout, null, {
14+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
15+
});
16+
},
17+
enhanceApp({ app, router, siteData }) {
18+
BackToTopButton(app);
19+
},
20+
} satisfies Theme;

‎.vitepress/theme/style.css‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create a accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attached to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#bd34fe 30%,
98+
#41d1ff
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
131+
scroll-behavior: smooth;
132+
}
133+
134+
/**
135+
* Component: Algolia
136+
* -------------------------------------------------------------------------- */
137+
138+
.DocSearch {
139+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
140+
}
141+
142+
/**
143+
* Component: Logo
144+
* -------------------------------------------------------------------------- */
145+
146+
html.dark .light-only {
147+
display: none !important;
148+
}
149+
150+
html:not(.dark) .dark-only {
151+
display: none !important;
152+
}

‎.vuepress/client.ts‎

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

0 commit comments

Comments
 (0)