mavlink-devguide/.vitepress/config.mjs

import { defineConfig } from "vitepress";
const getSidebar = require("./get_sidebar.js");

import openEditor from "open-editor"; // Open file locally via edit

// Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
import tabsPlugin from "@red-asuka/vitepress-plugin-tabs";

// https://vitepress.dev/reference/site-config
export default defineConfig({
  title: "MAVLink Guide",
  description: "MAVLink Developer Guide",
  //base: process.env.BRANCH_NAME ? "/" + process.env.BRANCH_NAME + "/" : "", //Build doesn't use branches!
  base: "",
  lastUpdated: true,
  sitemap: {
    hostname: "https://mavlink.io",
  },
  srcExclude: [
    "de/**/*.md",
    "ja/**/*.md",
    "ru/**/*.md",
    "tr/**/*.md",
    //"ko/**/*.md",
    //"zh/**/*.md",
    "uk/**/*.md",
    "**/_*.md", //Remove source docs that start with "_" (included/not rendered)
  ],
  ignoreDeadLinks: true,
  markdown: {
    math: true,
    config: (md) => {
      // use more markdown-it plugins!
      tabsPlugin(md); //https://github.com/Red-Asuka/vitepress-plugin-tabs
    },
  },
  vite: {
    plugins: [
      {
        // Open file locally via edit
        name: "open-in-editor",
        configureServer(server) {
          server.middlewares.use("/__open-in-editor", (req, res, next) => {
            if (!req.url) return next();
            const q = new URL(req.url, "http://a.com").searchParams;
            const file = q.get("file");
            if (!file) return next();
            const line = Number.parseInt(q.get("line")) || 1;
            const column = Number.parseInt(q.get("column")) || 1;
            // Open editor if EDITOR environment variable is set
            if (typeof process.env.EDITOR !== "undefined") {
              openEditor([{ file, line, column }]);
            } else {
              console.warn(
                "EDITOR environment variable is not set. Skipping opening file."
              );
            }
            res.statusCode = 204;
            res.end();
          });
        },
      },
    ],
  },
 
  locales: {
    en: {
      label: "English",
      // other locale specific properties...
      themeConfig: {
        sidebar: getSidebar.sidebar("en"), // Generated sidebar from SUMMARY.md files
        editLink: {
          text:
            /* We get a github link if CI env is defined,
            or if it isn't defined and a local editor isn't defined) */
            typeof process.env.CI !== "undefined" ||
            typeof process.env.EDITOR === "undefined"
              ? "Edit on GitHub"
              : "Open in your editor",
          pattern:
            typeof process.env.CI !== "undefined" ||
            typeof process.env.EDITOR === "undefined"
              ? ({ filePath, frontmatter }) => {
                  if (frontmatter.newEditLink) {
                    //newEditLink defines a frontmatter key you can use to append a path to master
                    return `https://github.com/mavlink/mavlink-devguide/edit/master/${frontmatter.newEditLink}`;
                  } else {
                    return `https://github.com/mavlink/mavlink-devguide/edit/master/${filePath}`;
                  }
                }
              : (c) =>
                  `${
                    window.location.origin
                  }/__open-in-editor?file=${encodeURIComponent(
                    c.frontmatter.newEditLink
                      ? c.frontmatter.newEditLink
                      : c.filePath
                  )}`,
        },
      },
    },

    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.
  //Also injects per-page SEO metadata (description, OpenGraph, canonical) into the
  //server-rendered <head> so message pages are better crawled/snippeted by search engines.
  async transformPageData(pageData, { siteConfig }) {
    console.log(pageData.filePath);

    const desc =
      pageData.frontmatter.description ||
      pageData.description ||
      (pageData.title
        ? `${pageData.title} — MAVLink message, enum and command reference.`
        : "MAVLink Developer Guide");

    // Set pageData.description so VitePress's own <meta name="description"> uses it
    // (pushing a second description tag in head would be deduped in favour of the default).
    pageData.description = desc;

    const url =
      "https://mavlink.io/" +
      pageData.relativePath
        .replace(/(^|\/)index\.md$/, "$1")
        .replace(/\.md$/, ".html");

    pageData.frontmatter.head ??= [];
    pageData.frontmatter.head.push(
      ["meta", { property: "og:title", content: pageData.title }],
      ["meta", { property: "og:description", content: desc }],
      ["meta", { property: "og:type", content: "article" }],
      ["meta", { property: "og:url", content: url }],
      ["link", { rel: "canonical", href: url }]
    );
  },

  //

  themeConfig: {
    // https://vitepress.dev/reference/default-theme-config
    siteTitle: false,
    logo: {
      light: "/site/logo_mavlink_header_lightmode.png",
      dark: "/site/logo_mavlink_header_darkmode.png",
      alt: "",
    },
    sidebar: getSidebar.sidebar("en"),
    externalLinkIcon: true,

    editLink: {
      pattern: "https://crowdin.com/project/mavlink",
      text: "Edit translation on Crowdin",
    },

    search: {
      provider: "local",
    },

    nav: [
      {
        text: "Messages",
        link: "/en/messages/common.md",
      },
      {
        text: "FAQ",
        link: "/en/about/faq.md",
      },
      {
        text: "Implementations",
        items: [
          {
            text: "ArduPilot",
            link: "http://ardupilot.org/",
          },
          {
            text: "PX4",
            link: "http://px4.io/",
          },
          {
            text: "Other",
            link: "/en/about/implementations.md",
          },
        ],
      },
      {
        text: "Languages",
        items: [
          {
            text: "C (mavgen)",
            link: "/en/mavgen_c/",
          },
          {
            text: "Python (Pymavlink)",
            link: "/en/mavgen_python/",
          },
          {
            text: "Rust (rust-mavlink)",
            link: "https://docs.rs/mavlink/latest/mavlink/",
          },
          {
            text: "Other",
            link: "/en/#supported_languages",
          },
        ],
      },

      {
        text: "Support",
        link: "/en/about/support.md",
      },
    ],

    socialLinks: [
      { icon: "github", link: "https://github.com/mavlink/mavlink" },
    ],
  },

  head: [
    ["link", { rel: "icon", href: "/en/favicon.ico" }],
    [
      "script",
      {
        async: "",
        src: "https://www.googletagmanager.com/gtag/js?id=G-91EWVWRQ93",
      },
    ],
    [
      "script",
      {},
      `window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'G-91EWVWRQ93');`,
    ],
  ],

  vue: {
    template: {
      compilerOptions: {
        isCustomElement: (tag) => tag === "lite-youtube",
      },
    },
  },
});