Switch to Vitepress

.gitignore

@@ -2,6 +2,5 @@
 .idea/
 node_modules/
 
-.vuepress/.cache
-.vuepress/.temp
-.vuepress/dist
+.vitepress/cache
+.vitepress/dist

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "plugins": ["prettier-plugin-vitepress"],
+  "proseWrap": "always",
+  "singleQuote": false,
+  "semi": true
+}

.vitepress/config.mts

@@ -0,0 +1,166 @@
+import { defineConfig } from "vitepress";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "MagicMirror² Docs",
+  description: "The open source modular smart mirror platform.",
+  lang: "en",
+  head: [
+    [
+      "script",
+      {
+        async: "",
+        src: "https://www.googletagmanager.com/gtag/js?id=UA-1219071-59",
+      },
+    ],
+    [
+      "script",
+      {},
+      `window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'TAG_ID');`,
+    ],
+  ],
+  sitemap: {
+    hostname: "https://docs.magicmirror.builders/",
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    carbonAds: {
+      code: "CK7IC23N",
+      placement: "magicmirror",
+    },
+    editLink: {
+      pattern:
+        "https://github.com/MagicMirrorOrg/MagicMirror-Documentation/blob/master/:path",
+      text: "Help us improve this page!",
+    },
+    lastUpdated: {
+      text: "Updated at",
+    },
+    logo: "/logo.png",
+    nav: [
+      { text: "Donate", link: "https://magicmirror.builders/donate" },
+      { text: "Forum", link: "https://forum.magicmirror.builders" },
+    ],
+    search: {
+      options: {
+        apiKey: "96d207343bbb5e45068a1e3c8d141bb4",
+        appId: "U3QOOOGLZR",
+        indexName: "docs-magicmirror-builders",
+      },
+      provider: "algolia",
+    },
+    sidebar: [
+      {
+        text: "Getting Started",
+        collapsed: false,
+        items: [
+          { text: "Introduction", link: "/" },
+          { text: "Requirements", link: "/getting-started/requirements.md" },
+          {
+            text: "Installation & Usage",
+            link: "/getting-started/installation.md",
+          },
+          { text: "Upgrade Guide", link: "/getting-started/upgrade-guide.md" },
+        ],
+      },
+      {
+        text: "Configuration",
+        collapsed: true,
+        items: [
+          { text: "Introduction", link: "/configuration/introduction" },
+          {
+            text: "Autostart your MagicMirror²",
+            link: "/configuration/autostart",
+          },
+          { text: "Raspberry Specific", link: "/configuration/raspberry" },
+        ],
+      },
+      {
+        text: "Modules",
+        collapsed: true,
+        items: [
+          { text: "Introduction", link: "/modules/introduction" },
+          { text: "Configuration", link: "/modules/configuration" },
+          {
+            text: "Default Modules",
+            collapsed: true,
+            items: [
+              { text: "Alert", link: "/modules/alert" },
+              { text: "Calendar", link: "/modules/calendar" },
+              { text: "Clock", link: "/modules/clock" },
+              { text: "Compliments", link: "/modules/compliments" },
+              { text: "Hello World", link: "/modules/helloworld" },
+              { text: "Newsfeed", link: "/modules/newsfeed" },
+              {
+                text: "Update Notification",
+                link: "/modules/updatenotification",
+              },
+              { text: "Weather", link: "/modules/weather" },
+            ],
+          },
+          { text: "Animation Guide", link: "/modules/animate" },
+        ],
+      },
+      {
+        text: "Module Development",
+        collapsed: true,
+        items: [
+          { text: "Introduction", link: "/module-development/introduction" },
+          {
+            text: "The Core module file",
+            link: "/module-development/core-module-file",
+          },
+          { text: "The Node Helper", link: "/module-development/node-helper" },
+          {
+            text: "Rendering Component",
+            link: "/module-development/rendering",
+          },
+          {
+            text: "MagicMirror Helper Methods",
+            link: "/module-development/helper-methods",
+          },
+          { text: "Logger", link: "/module-development/logger" },
+          { text: "Notifications", link: "/module-development/notifications" },
+          {
+            text: "Weather Module Weather Provider Development",
+            link: "/module-development/weather-provider",
+          },
+          {
+            text: "How to write good documentation",
+            link: "/module-development/documentation",
+          },
+        ],
+      },
+      {
+        text: "Core Development",
+        collapsed: true,
+        items: [
+          { text: "Introduction", link: "/core-development/introduction.md" },
+          {
+            text: "Testing",
+            link: "/core-development/testing.md",
+          },
+          { text: "Debugging", link: "/core-development/debugging.md" },
+        ],
+      },
+      {
+        text: "About",
+        collapsed: true,
+        items: [
+          { text: "Manifesto", link: "/about/manifesto" },
+          { text: "Contributing Guidelines", link: "/about/contributing" },
+          { text: "Donate", link: "/about/donate" },
+          { text: "Support", link: "/about/support" },
+          { text: "License", link: "/about/LICENSE" },
+        ],
+      },
+    ],
+    socialLinks: [
+      { icon: "github", link: "https://github.com/MagicMirrorOrg/MagicMirror" },
+      { icon: "discord", link: "https://discord.gg/J5BAtvx" },
+    ],
+  },
+});

.vitepress/theme/index.ts

@@ -0,0 +1,20 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from "vue";
+import type { Theme } from "vitepress";
+import DefaultTheme from "vitepress/theme";
+import "./style.css";
+
+import BackToTopButton from "@miletorix/vitepress-back-to-top-button";
+import "@miletorix/vitepress-back-to-top-button/style.css";
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    });
+  },
+  enhanceApp({ app, router, siteData }) {
+    BackToTopButton(app);
+  },
+} satisfies Theme;

.vitepress/theme/style.css

@@ -0,0 +1,152 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ *
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attached to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+
+  scroll-behavior: smooth;
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+
+/**
+ * Component: Logo
+ * -------------------------------------------------------------------------- */
+
+html.dark .light-only {
+  display: none !important;
+}
+
+html:not(.dark) .dark-only {
+  display: none !important;
+}