Migrate from Jekyll + Just the Docs to VitePress

.github/workflows/pages.yml

@@ -1,5 +1,5 @@
-# Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy Jekyll site to Pages
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+name: Deploy VitePress site to Pages
 
 on:
   # Runs on pushes targeting the default branch
@@ -30,28 +30,24 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Setup node
+        with:
+          fetch-depth: 0 # For git-based features like lastUpdated
+      - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version: 20
-      - name: Install Node deps
+          cache: npm
+      - name: Install dependencies
         run: npm ci
-      - name: Compile typescript
+      - name: Build with VitePress
         run: npm run build
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0' # Not needed with a .ruby-version file
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-          cache-version: 0 # Increment this number if you need to re-download cached gems
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
-      - run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" # defaults output to '/_site'
-        env:
-          JEKYLL_ENV: production
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3 # This will automatically upload an artifact from the '/_site' directory
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

.vitepress/config.mts

@@ -0,0 +1,135 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: 'Hack GPON',
+  description: 'Worldwide wiki on how to access, change and edit ONTs',
+
+  // Keep URLs consistent with Jekyll
+  cleanUrls: true,
+
+  head: [
+    ['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }],
+    ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
+    ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
+    ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
+    ['link', { rel: 'manifest', href: '/site.webmanifest' }],
+    ['link', { rel: 'mask-icon', href: '/safari-pinned-tab.svg', color: '#5bbad5' }],
+    ['meta', { name: 'msapplication-TileColor', content: '#da532c' }],
+    ['meta', { name: 'theme-color', content: '#ffffff' }],
+  ],
+
+  themeConfig: {
+    logo: '/favicon-32x32.png',
+
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Quick Start', link: '/quick-start' },
+      { text: 'FAQ', link: '/faq' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Getting Started',
+        items: [
+          { text: 'Home', link: '/' },
+          { text: 'Quick Start', link: '/quick-start' },
+          { text: 'FAQ', link: '/faq' },
+        ]
+      },
+      {
+        text: 'ONT GPON',
+        collapsed: false,
+        link: '/ont-zte',
+        items: []
+      },
+      {
+        text: 'ONT XGS-PON',
+        collapsed: false,
+        items: []
+      },
+      {
+        text: 'ONT EPON',
+        collapsed: false,
+        items: []
+      },
+      {
+        text: 'Router PON',
+        collapsed: false,
+        items: []
+      },
+      {
+        text: 'Tools',
+        collapsed: false,
+        items: []
+      },
+      {
+        text: 'SFP Resources & standard',
+        collapsed: false,
+        items: []
+      },
+      {
+        text: 'GPON Resources & standard',
+        collapsed: false,
+        items: []
+      },
+      {
+        text: 'SFP cage',
+        collapsed: false,
+        items: []
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/hack-gpon/hack-gpon.github.io' }
+    ],
+
+    editLink: {
+      pattern: 'https://github.com/hack-gpon/hack-gpon.github.io/tree/main/:path',
+      text: 'Edit this page on GitHub'
+    },
+
+    footer: {
+      message: 'Copyright &copy; 2022-2023. The documentation hereby found is distributed under the terms of the <a href="https://github.com/hack-gpon/hack-gpon.github.io/blob/main/LICENSE">MIT License</a>. Any external reference, link or software retains its original license and is not under the control of this website. <a href="/privacy-policy">Privacy Policy</a>.',
+    },
+
+    search: {
+      provider: 'local'
+    },
+
+    outline: {
+      level: [2, 3]
+    }
+  },
+
+  // Custom rewrites to maintain Jekyll URL structure
+  rewrites: {
+    // ONT GPON: /_ont/ont-xxx.md -> /ont-xxx (remove _ont prefix, keep filename)
+    '_ont/:file': ':file',
+
+    // ONT XGS-PON: /_ont_xgs/ont-xxx.md -> /xgs/ont-xxx
+    '_ont_xgs/:file': 'xgs/:file',
+
+    // ONT EPON: /_ont_epon/xxx.md -> /epon/xxx
+    '_ont_epon/:file': 'epon/:file',
+
+    // Router PON: /_router_pon/xxx.md -> /router/xxx
+    '_router_pon/:file': 'router/:file',
+
+    // Tools, SFP, GPON, SFP cage: keep at root level as Jekyll did
+    '_tools/:file': ':file',
+    '_sfp/:file': ':file',
+    '_gpon/:file': ':file',
+    '_sfp_cage/:file': ':file',
+  },
+
+  vite: {
+    build: {
+      chunkSizeWarningLimit: 1000
+    },
+    resolve: {
+      alias: {
+        '@components': '/components'
+      }
+    }
+  }
+})

.vitepress/dist/404.html

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html lang="en-US" dir="ltr">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Page not found | Hack GPON</title>
+    <meta name="description" content="Opps. The page you are looking for got lost.">
+    <meta name="generator" content="VitePress v1.6.4">
+    <link rel="preload stylesheet" href="/assets/style.Css-0sPs.css" as="style">
+    <link rel="preload stylesheet" href="/vp-icons.css" as="style">
+
+    <script type="module" src="/assets/app.CjECuGRX.js"></script>
+    <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
+    <link rel="modulepreload" href="/assets/chunks/theme._654pWPK.js">
+    <link rel="modulepreload" href="/assets/chunks/framework.Bh_scrrl.js">
+    <link rel="modulepreload" href="/assets/404.md.zRpvNB6j.lean.js">
+    <link rel="icon" type="image/x-icon" href="/favicon.ico">
+    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
+    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
+    <link rel="manifest" href="/site.webmanifest">
+    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
+    <meta name="msapplication-TileColor" content="#da532c">
+    <meta name="theme-color" content="#ffffff">
+    <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
+    <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>window.__VP_HASH_MAP__=JSON.parse("{\"404.md\":\"zRpvNB6j\",\"contributing.md\":\"Ci-JeDRX\",\"faq.md\":\"QkKpst0D\",\"index.md\":\"Dvhv4AqO\",\"privacy-policy.md\":\"DVLfz0iV\",\"quick-start.md\":\"b5h5pd41\",\"readme.md\":\"D9i_AYR4\",\"test-page.md\":\"DxLNJDqB\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Hack GPON\",\"description\":\"Worldwide wiki on how to access, change and edit ONTs\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/favicon-32x32.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick Start\",\"link\":\"/quick-start\"},{\"text\":\"FAQ\",\"link\":\"/faq\"}],\"sidebar\":[{\"text\":\"Getting Started\",\"items\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Quick Start\",\"link\":\"/quick-start\"},{\"text\":\"FAQ\",\"link\":\"/faq\"}]},{\"text\":\"ONT GPON\",\"collapsed\":false,\"link\":\"/ont-zte\",\"items\":[]},{\"text\":\"ONT XGS-PON\",\"collapsed\":false,\"items\":[]},{\"text\":\"ONT EPON\",\"collapsed\":false,\"items\":[]},{\"text\":\"Router PON\",\"collapsed\":false,\"items\":[]},{\"text\":\"Tools\",\"collapsed\":false,\"items\":[]},{\"text\":\"SFP Resources & standard\",\"collapsed\":false,\"items\":[]},{\"text\":\"GPON Resources & standard\",\"collapsed\":false,\"items\":[]},{\"text\":\"SFP cage\",\"collapsed\":false,\"items\":[]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/hack-gpon/hack-gpon.github.io\"}],\"editLink\":{\"pattern\":\"https://github.com/hack-gpon/hack-gpon.github.io/tree/main/:path\",\"text\":\"Edit this page on GitHub\"},\"footer\":{\"message\":\"Copyright &copy; 2022-2023. The documentation hereby found is distributed under the terms of the <a href=\\\"https://github.com/hack-gpon/hack-gpon.github.io/blob/main/LICENSE\\\">MIT License</a>. Any external reference, link or software retains its original license and is not under the control of this website. <a href=\\\"/privacy-policy\\\">Privacy Policy</a>.\"},\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
+
+  </body>
+</html>