add packages

Author: a-gave

.github/workflows/deploy.yml

@@ -32,6 +32,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           fetch-depth: 0 # Not needed if lastUpdated is not enabled
+          submodules: 'recursive' # Fetch lime-packages and network-profiles
       - uses: pnpm/action-setup@v4 # Uncomment this block if you're using pnpm
         with:
           version: 9 # Not needed if you've set "packageManager" in package.json
@@ -45,6 +46,8 @@ jobs:
         uses: actions/configure-pages@v4
       - name: Install dependencies
         run: pnpm install # or pnpm install / yarn install / bun install
+      - name: Prebuild with VitePress
+        run: pnpm run prebuild # or pnpm docs:build / yarn docs:build / bun run docs:build
       - name: Build with VitePress
         run: pnpm run build # or pnpm docs:build / yarn docs:build / bun run docs:build
       - name: Upload artifact

.gitignore

@@ -3,3 +3,8 @@ dist
 temp
 
 node_modules/
+/docs/packages/**
+!/docs/packages/index.md
+
+/lime-packages
+/network-profiles

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lime-packages"]
+	path = lime-packages
+	url = https://github.com/libremesh/lime-packages
+[submodule "network-profiles"]
+	path = network-profiles
+	url = https://github.com/libremesh/network-profiles

docs/.vitepress/config.mts

@@ -11,7 +11,7 @@ const libremesh = {
   oldstable_branch_openwrt: ['19.07'],
 }
 
-const packages = await getFiles('docs/packages/*.md'); // Path to folder
+const packages = await getFiles('docs/packages/*/index.md'); // Path to folder
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -29,6 +29,13 @@ export default defineConfig({
     },
   },
 
+  rewrites: {
+    // ':page*': 'docs/:page*',
+    // 'packages/pkg-a/src/foo.md': 'pkg-a/foo.md',
+    // 'packages/pkg-b/src/index.md': 'pkg-b/index.md',
+    // 'packages/pkg-b/src/bar.md': 'pkg-b/bar.md'
+  },
+
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     logo: { light: '/libremesh_logo.svg', dark: '/libremesh_logo.svg', alt: 'Logo' },
@@ -92,13 +99,13 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
       text: 'User Guide',
       collapsed: false,
       items: [
-        { text: 'Connecting to the router', link: '/install/connecting' },
+        { text: 'Connecting to the router', link: '/guide/connecting' },
         { text: 'Packages selection', 
-          link: '/install/packages-selection', 
+          link: '/guide/packages-selection', 
           collapsed: true,
           items: [
-          { text: 'Build customization', link: '/install/packages-selection' },
-          { text: 'Network Profiles', link: '/install/network-profiles' }
+          { text: 'Build customization', link: '/guide/packages-selection' },
+          { text: 'Network Profiles', link: '/guide/network-profiles' }
         ] },
         { text: 'Build LibreMesh', 
           link: '/build',
@@ -114,7 +121,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
       text: 'Developer Guide',
       collapsed: false,
       items: [
-        { text: 'Run it on QEMU', link: '/install/qemu' }
+        { text: 'Run it on QEMU', link: '/guide/qemu' }
       ]
     },
     {
@@ -145,8 +152,8 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
     },
     {
       text: 'Packages',
-      collapsed: false,
-      link: '/resources',
+      collapsed: true,
+      link: '/packages',
       items: generateSidebarItems(packages),
     },
   ]

docs/.vitepress/sidebar.ts

@@ -17,9 +17,12 @@ export function getFiles(path: string): Promise<INavItem[]> {
   return new Promise((resolve, reject) => {
     let navigation: INavItem[] = [];
     const filePath = path;
+    console.log(path)
     const files: string[] = glob.sync(filePath);
+    console.log(files)
     files.sort();
     for (const file of files) {
+      console.log(file)
       const fileData = fs.readFileSync(file).toString();
       const fm = matter(fileData);
 
@@ -28,6 +31,8 @@ export function getFiles(path: string): Promise<INavItem[]> {
         title = file;
       }
 
+      console.log(title)
+
       navigation.push({
         title,
         id: fm.data.id, // Custom data

docs/.vitepress/theme/LayoutWide.vue

@@ -0,0 +1,20 @@
+<script setup>
+import DefaultTheme from 'vitepress/theme'
+
+const { Layout } = DefaultTheme
+</script>
+
+<template>
+  <div v-if="frontmatter.home">
+    <h1>{{ site.title }}</h1>
+    <p>{{ site.description }}</p>
+    <!-- <ul>
+      <li><a href="/markdown-examples.html">Markdown Examples</a></li>
+      <li><a href="/api-examples.html">API Examples</a></li>
+    </ul> -->
+  </div>
+  <div v-else>
+    <a href="/">Home</a>
+    <Content />
+  </div>
+</template>

docs/.vitepress/theme/index.ts

@@ -3,15 +3,33 @@ import { h } from 'vue'
 import type { Theme } from 'vitepress'
 import DefaultTheme from 'vitepress/theme'
 import './style.css'
+import { redirects } from './redirects'
+import LayoutWide from './LayoutWide.vue'
 
 export default {
   extends: DefaultTheme,
   Layout: () => {
     return h(DefaultTheme.Layout, null, {
       // https://vitepress.dev/guide/extending-default-theme#layout-slots
+      'wide': () => h(LayoutWide)
     })
   },
   enhanceApp({ app, router, siteData }) {
-    // ...
+
+    // add layout
+    app.component('wide', LayoutWide)
+
+    // preserve old links
+    router.onBeforeRouteChange = (to: string) => {
+      const path = to.replace(/\.html$/i, ''),
+          toPath = redirects[path];
+
+      if (toPath) {
+          setTimeout(() => { router.go(toPath); })
+          return false;
+      } else {
+          return true;
+      }
+    }
   }
 } satisfies Theme

docs/.vitepress/theme/redirects.ts

@@ -0,0 +1,9 @@
+// .vitepress/theme/redirects.ts
+
+export const redirects = {
+  // '/path/from': '/path/to',
+  '/development': '/build/buildroot/debian',
+  '/howitworks': '/what-is-libremesh',
+  '/docs/en_quick_starting_guide': '/getting-started',
+  '/docs/en_connecting_nodes': '/guide/connecting',
+}

docs/build/imagebuilder.md

@@ -4,7 +4,7 @@ aside: false
 
 <script setup>
 import { data as openwrt } from '/openwrt.data.js'
-import { data as packages } from '/packages.data.js'
+// import { data as packages } from '/packages.data.js'
 
 // console.log(packages)
 openwrt.stable_branch = openwrt.stable_version.substr(0,5)
@@ -211,7 +211,7 @@ make image \
 
 ### Build using Network Profiles
 
-Refers to [Network Profiles](/install/network-profiles)
+Refers to [Network Profiles](/guide/network-profiles)
 
 ```sh
 make image \