[WIP] Pr vitepress version test origin - deploy workflow

.github/workflows/deploy.yml

@@ -0,0 +1,68 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - '*'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        #with:
+          #fetch-depth: 0 # Not needed if lastUpdated is not enabled
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        #run: npm ci # or pnpm install / yarn install / bun install
+        run: yarn install
+      - name: Build with VitePress
+        run: |
+          yarn docs:build_ubuntu
+          touch .vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: .vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -22,4 +22,14 @@ logs
 
 #Sublime Projects
 *.sublime-project
-*.sublime-workspace
+*.sublime-workspace
+
+
+# vitepress - user guide
+node_modules/
+#docs/.vitepress/cache/
+#docs/.vitepress/dist/
+.vitepress/cache/
+.vitepress/dist/
+.vitepress/.temp/
+

.vitepress/config.mjs

@@ -0,0 +1,151 @@
+import { defineConfig } from "vitepress";
+const getSidebar = require("./get_sidebar.js");
+//import { getSidebar } from "./get_sidebar";
+
+import markdownItVideo from "markdown-it-video";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "PX4 Guide (main)",
+  description: "PX4 User and Developer Guide",
+  base: process.env.BRANCH_NAME
+    ? "/" + process.env.BRANCH_NAME + "/"
+    : "/px4_user_guide/",
+  srcExclude: [
+    "de/**/*.md",
+    "ja/**/*.md",
+    "ru/**/*.md",
+    "tr/**/*.md",
+    "uk/**/*.md",
+  ],
+  ignoreDeadLinks: true,
+  markdown: {
+    math: true,
+
+    //   container: {
+    //     tipLabel: "Note",
+    //   },
+
+    config: (md) => {
+      // use more markdown-it plugins!
+      md.use(markdownItVideo);
+    },
+  },
+  locales: {
+    en: {
+      label: "English",
+      // other locale specific properties...
+      themeConfig: {
+        sidebar: getSidebar.sidebar("en"),
+      },
+    },
+    zh: {
+      label: "中文 (Chinese)",
+      lang: "zh-CN", // optional, will be added  as `lang` attribute on `html` tag
+      themeConfig: {
+        sidebar: getSidebar.sidebar("zh"),
+      },
+      // other locale specific properties...
+    },
+    ko: {
+      label: "한국어 (Korean)",
+      lang: "ko-KR", // optional, will be added  as `lang` attribute on `html` tag
+      themeConfig: {
+        sidebar: getSidebar.sidebar("ko"),
+      },
+
+      // other locale specific properties...
+    },
+  },
+  //Logs every page loaded on build. Good way to catch errors not caught by other things.
+  async transformPageData(pageData, { siteConfig }) {
+    console.log(pageData.filePath);
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: "/px4-logo.svg",
+    sidebar: getSidebar.sidebar("en"),
+    editLink: {
+      pattern: "https://github.com/PX4/PX4-user_guide/edit/main/:path",
+      text: "Edit on GitHub",
+    },
+
+    search: {
+      provider: process.env.BRANCH_NAME ? "algolia" : "local",
+      //provider: "local",
+      //provider: "algolia",
+      options: {
+        appId: "HHWW7I44JO",
+        apiKey: "48919e1dffc6e0ce4c0d6331343d2c0e",
+        indexName: "px4",
+        searchParameters: {
+          facetFilters: [`version:${process.env.BRANCH_NAME}`],
+        },
+      },
+    },
+
+    nav: [
+      {
+        text: "PX4",
+        items: [
+          {
+            text: "Website",
+            link: "https://px4.io/",
+            ariaLabel: "PX4 website link",
+          },
+          {
+            text: "Autopilot Source Code",
+            link: "https://github.com/PX4/PX4-Autopilot",
+          },
+          {
+            text: "Docs Source Code",
+            link: "https://github.com/PX4/PX4-user_guide",
+          },
+        ],
+      },
+      {
+        text: "Dronecode",
+        items: [
+          {
+            text: "QGroundControl",
+            link: "http://qgroundcontrol.com/",
+          },
+          {
+            text: "MAVSDK",
+            link: "https://mavsdk.mavlink.io/",
+          },
+          {
+            text: "MAVLINK",
+            link: "https://mavlink.io/en/",
+          },
+          {
+            text: "QGroundControl Guide",
+            link: "https://docs.qgroundcontrol.com/master/en/qgc-user-guide/",
+          },
+          {
+            text: "Dronecode Camera Manager",
+            link: "https://camera-manager.dronecode.org/en/",
+          },
+        ],
+      },
+      {
+        text: "Support",
+        link: "https://docs.px4.io/main/en/contribute/support.html",
+      },
+      {
+        text: "Version",
+        items: [
+          { text: "main", link: "https://docs.px4.io/main/zh/" },
+          { text: "v1.14", link: "https://docs.px4.io/v1.14/zh/" },
+          { text: "v1.13", link: "https://docs.px4.io/v1.13/zh/" },
+          { text: "v1.12", link: "https://docs.px4.io/v1.12/zh/" },
+          { text: "v1.11", link: "https://docs.px4.io/v1.11/zh/" },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: "github", link: "https://github.com/PX4/PX4-user_guide" },
+    ],
+  },
+});