docusaurus.config.js

const admonitions = require("./config/admonitions.config.js");
const headTags = require("./config/scripts.config.js");

module.exports = {
  title: "Unity Multiplayer",
  tagline: "Build multiplayer games in Unity",
  url: "https://docs-multiplayer.unity3d.com/",
  headTags,
  staticDirectories: ["public", "static"],
  baseUrl: "/",
  onBrokenLinks: "ignore", // todo: review and set to throw or at least warn
  onBrokenMarkdownLinks: "ignore", // todo: review and set to throw or at least warn
  favicon: "img/favicon.ico",
  trailingSlash: true,
  organizationName: "unity", // Usually your GitHub org/user name.
  projectName: "docusaurus", // Usually your repo name.
  markdown: {
    mermaid: true,
  },
  themes: ["@docusaurus/theme-mermaid"],
  themeConfig: {
    mermaid: {
      theme: { light: "neutral", dark: "dark" },
    },
    docs: {
      sidebar: {
        hideable: true,
      },
    },
    // Announcement across entire site at top of pages
    announcementBar: {
      id: "prerelease", // Any value that will identify this message.
      content:
        '⭐️ If you like our documentation, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/Unity-Technologies/com.unity.multiplayer.docs">GitHub</a> and <a target="_blank" rel="noopener noreferrer" href="https://github.com/Unity-Technologies/com.unity.multiplayer.docs/wiki">contribute</a>! ⭐️',
      backgroundColor: "#3578e5", // Defaults to `#fff`.
      textColor: "#ffffff", // Defaults to `#000`.
      isCloseable: true, // Defaults to `true`.
    },
    algolia: {
      apiKey: "dd157a25931bf7948bfc08e79fbe2c8c",
      appId: "42DEOQD6E7",
      indexName: "MultiplayerDocs",

      // Optional: for versioned docs
      //contextualSearch: false,

      // Optional: Algolia search parameters
      //searchParameters: {},

      //... other Algolia params
    },

    colorMode: {
      defaultMode: "dark",
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    // Code block themes and languages
    prism: {
      theme: require("prism-react-renderer/themes/vsLight"),
      darkTheme: require("prism-react-renderer/themes/vsDark"),
      additionalLanguages: ["csharp", "powershell", "java", "markdown"],
    },
    // FOOTER links and content
    footer: {
      style: "dark",
      links: [
        {
          title: "Unity",
          items: [
            {
              label: "Our Company",
              href: "https://unity.com/",
            },
            {
              label: "Unity Learn",
              href: "https://learn.unity.com/",
            },
            {
              label: "Unity Manual",
              href: "https://docs.unity3d.com/Manual/index.html",
            },
            {
              label: "Unity Scripting Reference",
              href: "https://docs.unity3d.com/ScriptReference/index.html",
            },
          ],
        },
        {
          title: "Multiplayer",
          items: [
            {
              label: "Licenses",
              type: "doc",
              to: "/reference/license",
              docsPluginId: "reference",
            },
            {
              label: "GitHub - Netcode",
              href: "https://github.com/Unity-Technologies/com.unity.netcode.gameobjects",
            },
            {
              label: "GitHub - Docs",
              href: "https://github.com/Unity-Technologies/com.unity.multiplayer.docs",
            },
            {
              label: "Netcode for GameObjects Releases",
              href: "https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/releases",
            },
            {
              label: "Boss Room Releases",
              href: "https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases/latest",
            },
            {
              label: "Bitesize Samples",
              href: "https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize",
            },
            {
              label: "Multiplayer RFCs",
              href: "https://github.com/Unity-Technologies/com.unity.multiplayer.rfcs",
            },
          ],
        },
        {
          title: "Contact",
          items: [
            {
              label: "Unity Multiplayer Discussions",
              href: "https://discussions.unity.com/lists/multiplayer",
            },
            {
              label: "Unity Discussions",
              href: "https://discussions.unity.com",
            },
            {
              label: "Discord",
              href: "https://discord.gg/buMxnnPvTb",
            },
          ],
        },
      ],
      copyright: `© ${new Date().getFullYear()} Unity Technologies`,
    },
    navbar: {
      title: "Multiplayer",
      logo: {
        alt: "Unity",
        src: "img/logo.png",
      },
      items: [
        // Netcode for GameObjects Documentation Button
        {
          label: "Netcode for GameObjects",
          // className: 'nav-break',
          type: "doc",
          docId: "about",
          position: "left",
        },
        // Netcode for Gameobjects Versions Dropdown
        {
          type: "docsVersionDropdown",
          position: "left",
          // Add additional dropdown items at the beginning/end of the dropdown.
          //dropdownItemsBefore: [],
          // dropdownItemsAfter: [{to: '/versions', label: 'All versions'}],
          // Do not add the link active class when browsing docs.
          dropdownActiveClassDisabled: true,
          docsPluginId: "default",
        },
        // Transport Documentation Button
        {
          type: "doc",
          docId: "about",
          label: "Transport",
          position: "left",
          docsPluginId: "transport",
          className: "nav-break",
        },
        // Transport Versions Dropdown
        {
          type: "docsVersionDropdown",
          position: "left",
          dropdownActiveClassDisabled: true,
          docsPluginId: "transport",
        },
        // Multiplayer Tools Documentation Button
        {
          type: "doc",
          docId: "about",
          label: "Multiplayer Tools",
          position: "left",
          docsPluginId: "tools",
          className: "nav-break",
        },
        // Multiplayer Tools Versions Dropdown
        {
          type: "docsVersionDropdown",
          position: "left",
          dropdownActiveClassDisabled: true,
          docsPluginId: "tools",
        },
        // Multiplayer Play Mode Documentation Button
        {
          type: "doc",
          docId: "about",
          label: "Multiplayer Play Mode",
          position: "left",
          docsPluginId: "mppm",
          className: "nav-break",
        },
        // Multiplayer Play Mode Versions Dropdown
        {
          type: "docsVersionDropdown",
          position: "left",
          dropdownActiveClassDisabled: true,
          docsPluginId: "mppm",
        },
      ],
    },
  },
  presets: [
    [
      // Configs for Netcode versioned content
      "@docusaurus/preset-classic",
      {
        docs: {
          routeBasePath: "netcode",
          sidebarPath: require.resolve("./sidebars.js"),
          // remarkPlugins: [require("mdx-mermaid")],
          showLastUpdateAuthor: true,
          showLastUpdateTime: true,
          // Edit URL for version
          editUrl: function ({ versionDocsDirPath, docPath }) {
            return `https://github.com/Unity-Technologies/com.unity.multiplayer.docs/edit/main/${versionDocsDirPath}/${docPath}`;
          },
          includeCurrentVersion: true,
          lastVersion: "current",
          versions: {
            current: {
              label: "2.2.0",
              path: "current",
            },
            "2.1.1": {
              label: "2.1.1",
              path: "2.1.1",
            },
            "2.0.0": {
              label: "2.0.0",
              path: "2.0.0",
            },
            "1.11.0": {
              label: "1.11.0",
              path: "1.11.0",
            },
            "1.10.0": {
              label: "1.10.0",
              path: "1.10.0",
            },
            "1.9.1": {
              label: "1.9.1",
              path: "1.9.1",
            },
            "1.8.1": {
              label: "1.8.1",
              path: "1.8.1",
            },
            "1.7.1": {
              label: "1.7.1",
              path: "1.7.1",
            },
            "1.6.0": {
              label: "1.6.0",
              path: "1.6.0",
            },
            "1.5.2": {
              label: "1.5.2",
              path: "1.5.2",
            },
            "1.4.0": {
              label: "1.4.0",
              path: "1.4.0",
            },
            "1.3.0": {
              label: "1.3.0",
              path: "1.3.0",
            },
            "1.1.0": {
              label: "1.1.0",
              path: "1.1.0",
            },
            "1.0.0": {
              label: "1.0.0",
              path: "1.0.0",
            },
          },
          admonitions,
        },
        theme: {
          customCss: require.resolve("./src/css/unity-custom.scss"),
        },
        sitemap: {
          changefreq: "weekly",
          priority: 0.5, //do not change, search requires
        },
      },
    ],
  ],
  plugins: [
    [
      // Configs for Transport versioned content
      "@docusaurus/plugin-content-docs",
      {
        id: "transport",
        path: "transport",
        editUrl: function ({ versionDocsDirPath, docPath }) {
          return `https://github.com/Unity-Technologies/com.unity.multiplayer.docs/edit/main/${versionDocsDirPath}/${docPath}`;
        },
        includeCurrentVersion: true,
        lastVersion: "current",
        versions: {
          current: {
            label: "2.2.1",
            path: "current",
          },
          "2.0.0": {
            label: "2.0.0",
            path: "2.0.0",
          },
          "1.0.0": {
            label: "1.0.0",
            path: "1.0.0",
          },
        },
        editCurrentVersion: true,
        routeBasePath: "transport",
        sidebarPath: require.resolve("./sidebarsTransport.js"),
        showLastUpdateAuthor: true,
        showLastUpdateTime: true,
        admonitions,
      },
    ],
    [
      // Configs for Tools versioned content
      "@docusaurus/plugin-content-docs",
      {
        id: "tools",
        path: "tools",
        editUrl: function ({ versionDocsDirPath, docPath }) {
          return `https://github.com/Unity-Technologies/com.unity.multiplayer.docs/edit/main/${versionDocsDirPath}/${docPath}`;
        },
        includeCurrentVersion: true,
        lastVersion: "current",
        versions: {
          current: {
            label: "2.2.1",
            path: "current",
          },
          "2.1.0": {
            label: "2.1.0",
            path: "2.1.0",
          },
          "1.1.0": {
            label: "1.1.0",
            path: "1.1.0",
          },
          "1.0.0": {
            label: "1.0.0",
            path: "1.0.0",
          },
        },
        editCurrentVersion: true,
        routeBasePath: "tools",
        sidebarPath: require.resolve("./sidebarsTools.js"),
        showLastUpdateAuthor: true,
        showLastUpdateTime: true,
        admonitions,
      },
    ],
    [
      // Configs for MPPM versioned content
      "@docusaurus/plugin-content-docs",
      {
        id: "mppm",
        path: "mppm",
        editUrl: function ({ versionDocsDirPath, docPath }) {
          return `https://github.com/Unity-Technologies/com.unity.multiplayer.docs/edit/main/${versionDocsDirPath}/${docPath}`;
        },
        includeCurrentVersion: true,
        lastVersion: "current",
        versions: {
          current: {
            label: "1.4.0-pre",
            path: "current",
          },
          "1.3.3": {
            label: "1.3.3",
            path: "1.3.3",
          },
          "1.2.0": {
            label: "1.2.0",
            path: "1.2.0",
          },
          "1.1.0": {
            label: "1.1.0",
            path: "1.1.0",
          },
          "1.0.0": {
            label: "1.0.0",
            path: "1.0.0",
          },
          "0.6.0": {
            label: "0.6.0",
            path: "0.6.0",
          },
          "0.5.0": {
            label: "0.5.0",
            path: "0.5.0",
          },
          "0.4.0": {
            label: "0.4.0",
            path: "0.4.0",
          },
          "0.3.0": {
            label: "0.3.0",
            path: "0.3.0",
          },
        },
        editCurrentVersion: true,
        routeBasePath: "mppm",
        sidebarPath: require.resolve("./sidebarsMPPM.js"),
        showLastUpdateAuthor: true,
        showLastUpdateTime: true,
        admonitions,
      },
    ],
    // [
    //   require.resolve("docusaurus-gtm-plugin"),
    //   {
    //     id: "GTM-5V25JL6", // GTM Container ID
    //   },
    // ],
    [
      "@docusaurus/plugin-client-redirects",
      {
        redirects: [
          {
            to: "/netcode/current/learn/bossroom/bossroom",
            from: "/docs/learn/bossroom/index.html",
          },
        ],
      },
    ],
    "plugin-image-zoom",
    "docusaurus-plugin-sass",
    "@saucelabs/theme-github-codeblock",
    "react-iframe",
  ],
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
    localeConfigs: {
      en: {
        htmlLang: "en-US",
      },
    },
  },
};