docusaurus.config.js

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
require("dotenv").config();
const math = require("remark-math");
const katex = require("rehype-katex");

const lightCodeTheme = require("prism-react-renderer/themes/vsDark");
const darkCodeTheme = require("prism-react-renderer/themes/oceanicNext");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "MultiversX Docs",
  titleDelimiter: "•",
  tagline:
    "A highly scalable, fast and secure blockchain platform for distributed apps, enterprise use cases and the new internet economy.",
  url: "https://docs.multiversx.com",
  baseUrl: "/",
  onBrokenLinks: "log",
  onBrokenMarkdownLinks: "log",
  favicon: "img/favicons/favicon.ico",

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "multiversx", // Usually your GitHub org/user name.
  projectName: "mx-docs", // Usually your repo name.

  // Even if you don't use internalization, you can use this field to set useful
  // metadata like html lang. For example, if your site is Chinese, you may want
  // to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: "/", // Serve the docs at the site's root
          sidebarPath: require.resolve("./sidebars.js"),
          /* other docs plugin options */
          remarkPlugins: [math],
          rehypePlugins: [katex],
        },
        blog: false, // Optional: disable the blog plugin
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        googleAnalytics: {
          trackingID: "UA-143242606-1",
        },
      }),
    ],
  ],

  stylesheets: [
    {
      href: "https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css",
      type: "text/css",
      integrity:
        "sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
      crossorigin: "anonymous",
    },
    {
      href: "https://fonts.googleapis.com/css?family=Montserrat:400,500,600&display=swap",
      type: "text/css",
      crossorigin: "anonymous",
    },
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: "dark",
        disableSwitch: true,
        respectPrefersColorScheme: false,
      },
      navbar: {
        logo: {
          alt: "MultiversX Docs",
          src: "img/logo_dark.svg",
          srcDark: "img/logo.svg",
        },
        items: [
          {
            href: "/developers/overview",
            label: "Develop",
            position: "left",
          },
          {
            href: "/validators/overview",
            label: "Validate",
            position: "left",
          },
          {
            href: "/integrators/overview",
            label: "Integrate",
            position: "left",
          },
          {
            href: "/technology/architecture-overview",
            label: "Learn",
            position: "left",
          },
          {
            href: "https://github.com/multiversx",
            position: "right",
            className: "header-github-link",
            "aria-label": "GitHub",
          },
          {
            href: "https://discord.gg/multiversxbuilders",
            position: "right",
            className: "header-discord-link",
            "aria-label": "Discord",
          },
          {
            href: "https://t.me/MultiversX",
            position: "right",
            className: "header-telegram-link",
            "aria-label": "Chat",
          },
          {
            type: "dropdown",
            position: "right",
            className: "header-app-change",
            "aria-label": "Websites",
            items: [
              {
                label: "Main Site",
                href: "https://multiversx.com",
                target: "_blank",
              },
              {
                label: "Wallet",
                href: "https://wallet.multiversx.com",
                target: "_blank",
              },
              {
                label: "Explorer",
                href: "https://explorer.multiversx.com",
                target: "_blank",
              },
              {
                label: "Bridge",
                href: "https://ad-astra.multiversx.com",
                target: "_blank",
              },
              {
                label: "xExchange",
                href: "https://xexchange.com",
                target: "_blank",
              },
              {
                label: "xLaunchpad",
                href: "https://xlaunchpad.com",
                target: "_blank",
              },
            ],
          },
        ],
      },
      image: "img/share.jpg",
      footer: {
        style: "light",
        links: [],
        copyright: `Copyright © ${new Date().getFullYear()} MultiversX. All rights reserved.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
        additionalLanguages: ["rust", "tsx", "jsonp"],
      },
      algolia: {
        // The application ID provided by Algolia
        appId: `${process.env.REACT_APP_ALGOLIA_APP_ID}`,
        // Public API key: it is safe to commit it
        apiKey: `${process.env.REACT_APP_ALGOLIA_SEARCH_KEY}`,
        indexName: "elrond",
        contextualSearch: false,
      },
      slugPreprocessor: (slugBase) =>
        slugBase.replace(/<([^>]+?)([^>]*?)>(.*?)<\/\1>/gi, ""),
    }),

  plugins: [
    [
      "@docusaurus/plugin-client-redirects",
      {
        redirects: [
          {
            from: "/sdk-and-tools/rest-api/api-com/",
            to: "/sdk-and-tools/rest-api/multiversx-api/",
          },
          {
            from: "/validators/elrond-go-scripts/config-scripts",
            to: "/validators/nodes-scripts/config-scripts",
          },
          {
            from: "/validators/elrond-go-scripts/install-update",
            to: "/validators/nodes-scripts/install-update",
          },
          {
            from: "/sdk-and-tools/dapp-core",
            to: "/sdk-and-tools/sdk-dapp",
          },
          {
            from: "/validators/staking-providers-apr",
            to: "/economics/staking-providers-apr",
          },
          {
            from: "/sdk-and-tools/rest-api/rest-api",
            to: "/sdk-and-tools/rest-api",
          },
          {
            from: "/developers/developer-reference/wasm-annotations",
            to: "/developers/developer-reference/sc-annotations",
          },
          {
            from: "/developers/developer-reference/wasm-modules",
            to: "/developers/developer-reference/sc-modules",
          },
          {
            from: "/developers/developer-reference/wasm-contract-calls",
            to: "/developers/developer-reference/sc-contract-calls",
          },
          {
            from: "/developers/developer-reference/wasm-api-functions",
            to: "/developers/developer-reference/sc-api-functions",
          },
          {
            from: "/developers/developer-reference/rust-smart-contract-debugging",
            to: "/developers/developer-reference/sc-debugging",
          },
          {
            from: "/developers/developer-reference/smart-contract-build-reference",
            to: "/developers/developer-reference/sc-build-reference",
          },
          {
            from: "/developers/developer-reference/random-numbers-in-smart-contracts",
            to: "/developers/developer-reference/sc-random-numbers",
          },
          {
            from: "/sdk-and-tools/erdjs",
            to: "/sdk-and-tools/sdk-js",
          },
          {
            from: "/sdk-and-tools/erdjs/erdjs-cookbook",
            to: "/sdk-and-tools/sdk-js/sdk-js-cookbook",
          },
          {
            from: "/sdk-and-tools/erdjs/extending-erdjs",
            to: "/sdk-and-tools/sdk-js/extending-sdk-js",
          },
          {
            from: "/sdk-and-tools/erdjs/writing-and-testing-erdjs-interactions",
            to: "/sdk-and-tools/sdk-js/writing-and-testing-sdk-js-interactions",
          },
          {
            from: "/sdk-and-tools/erdjs/erdjs-migration-guides",
            to: "/sdk-and-tools/sdk-js/sdk-js-migration-guides",
          },
          {
            from: "/sdk-and-tools/erdjs/erdjs-signing-providers",
            to: "/sdk-and-tools/sdk-js/sdk-js-signing-providers",
          },
          {
            from: "/sdk-and-tools/erdpy",
            to: "/sdk-and-tools/sdk-py",
          },
          {
            from: "/sdk-and-tools/erdpy/erdpy",
            to: "/sdk-and-tools/sdk-py",
          },
          {
            from: "/sdk-and-tools/erdpy/erdpy-cookbook",
            to: "/sdk-and-tools/sdk-py/sdk-py-cookbook",
          },
          {
            from: "/sdk-and-tools/erdpy/installing-erdpy",
            to: "/sdk-and-tools/sdk-py/installing-mxpy",
          },
          {
            from: "/sdk-and-tools/erdpy/configuring-erdpy",
            to: "/sdk-and-tools/sdk-py/configuring-mxpy",
          },
          {
            from: "/sdk-and-tools/erdpy/erdpy-cli",
            to: "/sdk-and-tools/sdk-py/mxpy-cli",
          },
          {
            from: "/sdk-and-tools/erdpy/deriving-the-wallet-pem-file",
            to: "/sdk-and-tools/sdk-py/deriving-the-wallet-pem-file",
          },
          {
            from: "/sdk-and-tools/erdpy/smart-contract-interactions",
            to: "/sdk-and-tools/sdk-py/smart-contract-interactions",
          },
          {
            from: "/sdk-and-tools/erdpy/sending-bulk-transactions",
            to: "/sdk-and-tools/sdk-py/sdk-py-cookbook",
          },
          {
            from: "/sdk-and-tools/erdpy/writing-and-running-mxpy-scripts",
            to: "/sdk-and-tools/sdk-py/sdk-py-cookbook",
          },
          {
            from: "/developers/mandos-reference/overview",
            to: "/developers/scenario-reference/overview",
          },
          {
            from: "/developers/mandos-reference/structure",
            to: "/developers/scenario-reference/structure",
          },
          {
            from: "/developers/mandos-reference/values-simple",
            to: "/developers/scenario-reference/values-simple",
          },
          {
            from: "/developers/mandos-reference/values-complex",
            to: "/developers/scenario-reference/values-complex",
          },
          {
            from: "/developers/mandos-reference/embed",
            to: "/developers/scenario-reference/embed",
          },
        ],
        createRedirects(existingPath) {
          return undefined; // Return a falsy value: no redirect created
        },
      },
    ],
  ],
};

module.exports = config;