feat: migrate to vitepress

Author: williarin

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/workflows/build_and_deploy.yml

@@ -23,21 +23,21 @@ jobs:
 
         steps:
             -   name: Checkout
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
 
             -   name: Setup Node
-                uses: actions/setup-node@v2
+                uses: actions/setup-node@v4
                 with:
-                    node-version: '18'
+                    node-version: '20'
 
             -   name: Install and build
                 run: |
-                    yarn install
-                    yarn docs:build
+                    npm install
+                    npm run docs:build
 
             -   name: Deploy
                 if: github.ref == 'refs/heads/master'
                 uses: JamesIves/github-pages-deploy-action@v4
                 with:
                     branch: publish
-                    folder: docs/.vuepress/dist
+                    folder: docs/.vitepress/dist

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .temp
-.cache
+docs/.vitepress/cache
+docs/.vitepress/dist

.nvmrc

@@ -1 +1 @@
-18
+20

README.md

@@ -1,4 +1,4 @@
-![Sword - Symfony meets WordPress](./docs/.vuepress/public/images/sword-logo-sm.png)
+![Sword - Symfony meets WordPress](./docs/public/images/sword-logo-sm.png)
 
 <br>
 
@@ -8,7 +8,7 @@
 
 Please check the docs at https://getsword.com
 
-Built with [VuePress 2](https://v2.vuepress.vuejs.org/).
+Built with [VitePress](https://vitepress.dev/).
 
 ## Contributing
 
@@ -17,4 +17,3 @@ Feel free to contribute by opening issues or pull requests.
 ## License
 
 [MIT](LICENSE)
-

docs/.vitepress/config.mts

@@ -0,0 +1,83 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  lang: 'en-US',
+  title: 'Sword',
+  description: "Documentation for Sword",
+  lastUpdated: true,
+  head: [
+    [
+      'link',
+      { rel: 'icon', href: '/images/favicon-sm.png' },
+    ],
+    [
+      'script',
+      { async: '', src: 'https://www.googletagmanager.com/gtag/js?id=G-92G4XJ5HFS' }
+    ],
+    [
+      'script',
+      {},
+      `window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'G-92G4XJ5HFS');`
+    ]
+  ],
+  markdown: {
+    lineNumbers: true,
+    theme: {
+      light: 'catppuccin-latte',
+      dark: 'dracula',
+    },
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: '/images/favicon-sm.png',
+    siteTitle: 'Sword',
+
+    search: {
+      provider: 'local'
+    },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2022-present William Arin'
+    },
+
+    nav: [
+      { text: 'Guide', link: '/guide/' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Introduction',
+        items: [
+          { text: 'What is Sword?', link: '/guide/index.md' },
+          { text: 'Installation', link: '/guide/installation.md' },
+          { text: 'Tooling', link: '/guide/tooling.md' },
+          { text: 'Production', link: '/guide/production.md' },
+          { text: 'Configuration reference', link: '/guide/configuration.md' },
+        ],
+      },
+      {
+        text: 'Tutorial',
+        items: [
+          { text: 'First steps', link: '/guide/tutorial/first-steps.md' },
+          { text: 'Services', link: '/guide/tutorial/services.md' },
+          { text: 'Widgets', link: '/guide/tutorial/widgets.md' },
+          { text: 'Translations', link: '/guide/tutorial/translations.md' },
+          { text: 'Database queries', link: '/guide/tutorial/database-queries.md' },
+          { text: 'Assets', link: '/guide/tutorial/assets.md' },
+          { text: 'Commands for WP-CLI', link: '/guide/tutorial/commands.md' },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/phpsword/sword-bundle' },
+      { icon: 'twitter', link: 'https://twitter.com/william_arin' },
+    ],
+
+  }
+})

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './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 }) {
+    // ...
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,140 @@
+/**
+ * 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 attched 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: #000000;
+  --vp-c-brand-2: #202325;
+  --vp-c-brand-3: #474c52;
+  --vp-c-brand-soft: #484b4e3d;
+
+  --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: #fff8d0;
+
+  --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-1);
+  --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: var(--vp-c-brand-1);
+
+  --vp-home-hero-image-background-image: none;
+  --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-green-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+
+html.dark {
+  --vp-c-white: #0e0e0e;
+  --vp-c-brand-1: #ffffff;
+  --vp-c-brand-2: #dfdfdf;
+  --vp-c-brand-3: #ADADAD;
+  --vp-c-brand-soft: #c8c9ca3d;
+
+  --vp-c-warning-soft: #5c4b2c;
+}