docusaurus.config.js

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer").themes.github;
const darkCodeTheme = require("prism-react-renderer").themes.dracula;

const releaseVersion = "0.7.10";

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "GP2040-CE",
  tagline: "Community Edition Firmware",
  favicon: "img/favicon.ico",

  url: "https://gp2040-ce.info",
  baseUrl: "/",

  organizationName: "OpenStickCommunity",
  projectName: "GP2040-CE",

  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",

  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },
  markdown: {
    mermaid: true,
  },
  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          routeBasePath: "/",
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],
  themes: [
    [
      "@easyops-cn/docusaurus-search-local",
      {
        hashed: true,
        highlightSearchTermsOnTargetPage: true,
        docsRouteBasePath: "/",
        indexBlog: false,
      },
    ],
    "@docusaurus/theme-mermaid",
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: "light",
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      announcementBar: {
        id: "new_release",
        content: `New Version Available! To get the v${releaseVersion} update, go to <a href="https://github.com/OpenStickCommunity/GP2040-CE/releases/tag/v${releaseVersion}" target="_blank">GP2040-CE Releases<a/>`,
        backgroundColor: "#ec008c",
        textColor: "#FFFFFF",
        isCloseable: true,
      },
      navbar: {
        logo: {
          alt: "GP2040-CE Logo",
          src: "img/gp2040-ce-logo.png",
        },
        items: [
          {
            type: "docSidebar",
            position: "right",
            sidebarId: "docSidebar",
            label: "Documentation",
            docId: "introduction",
          },
          {
            type: "docSidebar",
            position: "right",
            sidebarId: "webConfigSidebar",
            label: "Web Config",
            docId: "introduction",
          },
          {
            to: "/development/contribution-guide",
            label: "Contribute",
            position: "right",
            // activeBaseRegex: `/development/`,
          },
          {
            position: "right",
            to: "/downloads",
            label: "Downloads",
          },
          // {
          //   type: "docsVersionDropdown",
          //   position: "left",
          //   dropdownActiveClassDisabled: true,
          // },
          {
            "aria-label": "Discord Invite",
            className: "navbar-discord-link",
            href: "https://discord.gg/k2pxhke7q8",
            position: "right",
          },
          {
            "aria-label": "GitHub Repository",
            className: "navbar-github-link",
            href: "https://github.com/OpenStickCommunity/GP2040-CE",
            position: "right",
          },
        ],
      },
      docs: {
        sidebar: {
          hideable: true,
          autoCollapseCategories: false,
        },
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
      image: "img/gp2040-ce-social-card.png",
      metadata: [{ name: "twitter:card", content: "summary" }],
    }),
  plugins: [
    [
      "docusaurus-plugin-remote-content",
      {
        // options here
        name: "README", // used by CLI, must be path safe
        sourceBaseUrl:
          "https://raw.githubusercontent.com/OpenStickCommunity/GP2040-CE/main/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "/docs", // the base directory to output to.
        documents: ["README.md"], // the file names to download
        performCleanup: true,
        modifyContent(filename, content) {
          if (filename.includes("README")) {
            return content; // <-- this last part adds in the rest of the content, which would otherwise be discarded
          }

          // we don't want to modify this item, since it doesn't contain "README" in the name
          return undefined;
        },
      },
    ],
    [
      "@docusaurus/plugin-client-redirects",
      {
        redirects: [
          {
            // Redirect for console compatibility update
            to: "/faq/faq-console-compatibility",
            from: ["/faq/faq-ps4-ps5-compatibility"],
          },
        ],
      },
    ],
    [
      "content-docs",
      {
        id: "development",
        path: "development",
        routeBasePath: "development",
        editCurrentVersion: true,
        sidebarPath: "./sidebarsDevelopment.json",
      },
    ],
  ],
};

module.exports = config;