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,29 +99,29 @@ 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',
           collapsed: true,
           items: [
             { text: 'Build methods', link: '/build/' },
             { text: 'Imagebuilder', link: '/build/imagebuilder' },
-            { text: 'Buildroot', link: '/build/buildroot/debian'}
+            { text: 'Buildroot', link: '/build/buildroot'}
         ]}
       ]
     },
     {
       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,10 @@
+// .vitepress/theme/redirects.ts
+
+export const redirects = {
+  // '/path/from': '/path/to',
+  '/development': '/build/buildroot',
+  '/howitworks': '/what-is-libremesh',
+  '/docs/en_quick_starting_guide': '/getting-started',
+  '/docs/en_connecting_nodes': '/guide/connecting',
+  '/development-network_profiles': '/profiles'
+}

docs/build/buildroot/debian.md docs/build/buildroot.mddocs/build/buildroot/debian.md renamed to docs/build/buildroot.md

@@ -1,9 +1,15 @@
+---
+aside: false
+---
+
 <script setup>
 import { data as openwrt } from '/openwrt.data.js'
 </script>
 
 # Buildroot
 
+[[toc]]
+
 ## Build system setup
 Refers to the OpenWrt wiki [Build system setup](https://openwrt.org/docs/guide-developer/toolchain/install-buildsystem)
 for the package list of other Linux distributions.
@@ -77,7 +83,7 @@ make menuconfig
 
 
 
-Check out the +target+ (e.g. +ATH79+), +subtarget+ (e.g. +generic+) and +profile+ (e.g. +tl-wdr3600-v1+) of your router on https://openwrt.org/toh/start[OpenWrt table of hardware].
+Check out the +target+ (e.g. +ATH79+), +subtarget+ (e.g. +generic+) and +profile+ (e.g. +tl-wdr3600-v1+) of your router on [OpenWrt table of hardware](https://openwrt.org/toh/start).
 
 Select the _Target System_, _Subtarget_ and _Target Profile_ accordingly.
 
@@ -95,15 +101,14 @@ Select the _Target System_, _Subtarget_ and _Target Profile_ accordingly.
 Optionally, **deselect** unused packages:
 - Network -> ppp
 
-If you local community has a profile in the https://github.com/libremesh/network-profiles/[network-profiles repository], you can select it in:
+If you local community has a profile in the [network-profiles repository](https://github.com/libremesh/network-profiles/), you can select it in:
 
 - LibreMesh -> network-profile -> profile-your_community-your_profile
 
-[NOTE]
-=========================
+::: tip NOTE
 Network profiles are the specific configuration from the communities, and are stored in this collective 
-https://github.com/libremesh/network-profiles/[repository], but they can also be kept locally, depending on how every community network manages itself. For more instructions on how to create a profile or how to use a local one, check out the link:development-network_profiles.html[network profiles page].
-=========================
+[repository](https://github.com/libremesh/network-profiles/), but they can also be kept locally, depending on how every community network manages itself. For more instructions on how to create a profile or how to use a local one, check out the [network profiles page](../guide/network-profiles).
+:::
 
 **Select** (press space until when an asterisk appears, like `<*>`) LibreMesh packages:
 
@@ -119,10 +124,9 @@ https://github.com/libremesh/network-profiles/[repository], but they can also be
 ** shared-state-nodes_and_links (nodes_and_links module for shared-state)
 * LibreMesh -> babeld-auto-gw-mode
 
-[NOTE]
-=========================
-If after the compilation you don't see the compiled image in the `bin/targets/.../.../` folder, it is possible that your router has such a small flash memory that the aforementioed packages don't fit in it (it can happen also with routers having 8 MB of flash memory when selecting huge packages to be included). In this case, you can remove the `.config` generated packages list and repeat the packages selection without including `lime-app`. If the compiled image is still too large, try selecting only `lime-proto-anygw`, `lime-proto-batadv` and `lime-proto-babeld` or following https://openwrt.org/docs/guide-user/additional-software/saving_space[this guide].
-=========================
+::: tip NOTE
+If after the compilation you don't see the compiled image in the `bin/targets/.../.../` folder, it is possible that your router has such a small flash memory that the aforementioed packages don't fit in it (it can happen also with routers having 8 MB of flash memory when selecting huge packages to be included). In this case, you can remove the `.config` generated packages list and repeat the packages selection without including `lime-app`. If the compiled image is still too large, try selecting only `lime-proto-anygw`, `lime-proto-batadv` and `lime-proto-babeld` or following [this guide](https://openwrt.org/docs/guide-user/additional-software/saving_space).
+:::
 
 Some more packages are recommended but not mandatory for a working LibreMesh network. Consider avoiding to select the following packages _only_ if the created image is too large and does not fit in the router memory.
 
@@ -142,40 +146,37 @@ and this to be **de**-selected:
 
 - Network -> WirelessAPD -> wpad-basic-mbedtls
 
-[NOTE]
-=========================
+::: tip NOTE
 In order to have additional packages, the easiest way is to select them in menuconfig. More packages can be installed afterwards via +opkg+, but some of these require a specific kernel configuration to be in place. This can be achieved following link:development-kernel_vermagic.html[these additional instructions dealing with kernel vermagic]. Beware that this will increase noticeably the time and storage space required for the compilation.
-=========================
+:::
 
 Save and exit.
 
 At this stage there is the possibility to include custom files in the compiled firmware image. For this, you will have to create, inside the `openwrt/` directory, a `files/` directory containing the directory structure and files you want to add. For example, if you want to have a `/etc/config/lime-community` file you need to do the following:
 
------------------------------
+``` sh
 mkdir -p files/etc/config/
 touch files/etc/config/lime-community
------------------------------
+```
 
-and then edit the newly created `lime-community` file including your custom content. If a file from a package has the same name and path as a file in this directory, it will be overwritten. This is a quick way to include a custom configuration file, without the need to create an online link:development-network_profiles.html[network profile].
+and then edit the newly created `lime-community` file including your custom content. If a file from a package has the same name and path as a file in this directory, it will be overwritten. This is a quick way to include a custom configuration file, without the need to create an online [network profile](../guide/network-profiles).
 
 .Finally, compile the images
---------------------------------------------------------------------------------
+``` sh
 make -j$(nproc)
---------------------------------------------------------------------------------
+```
 
 If everything goes well you should find the produced binaries inside the +bin/+ directory.
 
 == Emulating on your computer with qemu
 
-Its possible to emulate a image compiled for x86_64 architecture. See link:https://github.com/libremesh/lime-packages/tree/master/tools[script] qemu_dev_start.sh and qemu_dev_stop.sh scripts.
+Its possible to emulate a image compiled for x86_64 architecture. See [script](https://github.com/libremesh/lime-packages/tree/master/tools) qemu_dev_start.sh and qemu_dev_stop.sh scripts.
 
-[NOTE]
-=========================
+::: tip NOTE
 You will be running something like:
-```
+``` sh
 sudo ./qemu_dev_start openwrt-x86-64-combined-ext4.img openwrt-x86-64-ramfs.bzImage
 ```
-More information link:https://github.com/libremesh/lime-packages/blob/master/TESTING.md[here]
-
-=========================
+More information in [TESTING.md](https://github.com/libremesh/lime-packages/blob/master/TESTING.md)
 
+:::

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)
@@ -32,6 +32,8 @@ const build = {
 
 # ImageBuilder
 
+[[toc]]
+
 Refers to the OpenWrt wiki [Using the Image Builder](https://openwrt.org/docs/guide-user/additional-software/imagebuilder)
 for detailed options
 
@@ -187,7 +189,7 @@ EOF
 
 ## Custom files
 Ideally add your own `lime-community` files within the container in the folder `./files/etc/config/`.    
-To find all possible options consult the [lime-example][lime-example] file.    
+To find all possible options consult the [`Configuration`][/reference/configuration] page.    
 
 Now create an image of your choice, to see the names of supported profiles run
 `make info` first.
@@ -211,7 +213,7 @@ make image \
 
 ### Build using Network Profiles
 
-Refers to [Network Profiles](/install/network-profiles)
+Refers to [Network Profiles](/guide/network-profiles)
 
 ```sh
 make image \