docusaurus.config.js

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

const codeTheme = require("prism-react-renderer/themes/dracula");
const remarkCodesandbox = require("remark-codesandbox");
const path = require("path");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "MetaMask developer documentation",
  // tagline: '',
  url: "https://docs.metamask.io",
  baseUrl: process.env.DEST || "/", // overwritten in github action for staging / latest
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/metamask-fox.svg",

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "metamask", // Usually your GitHub org/user name.
  projectName: "metamask-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"],
  },

  trailingSlash: true,

  scripts: [
    { src: "https://cmp.osano.com/AzZMxHTbQDOQD8c1J/a2e89f0e-f467-4542-bfea-30ea2c1a6648/osano.js" },
    { src: "https://plausible.io/js/script.js", defer: true, "data-domain": "docs.metamask.io" },
    { src: "/js/feedback-script.js", defer: true, async: true },
    { src: "/js/getfeedback.js", defer: true, async: true },
  ],

  markdown: {
    mermaid: true,
  },
  themes: ["@docusaurus/theme-mermaid"],

  presets: [
    [
      "@metamask/docusaurus-openrpc/dist/preset",
      /** @type {import('@metamask/docusaurus-openrpc/dist/preset').Options} */
      ({
        docs: {
          path: "wallet",
          routeBasePath: "wallet",
          sidebarPath: require.resolve("./wallet-sidebar.js"),
          breadcrumbs: false,
          editUrl: "https://github.com/MetaMask/metamask-docs/edit/main/",
          remarkPlugins: [
            require("remark-docusaurus-tabs"),
            [remarkCodesandbox, {
              mode: "iframe",
              autoDeploy: process.env.NODE_ENV === "production",
            }],
          ],
          openrpc: {
            openrpcDocument: "https://metamask.github.io/api-specs/latest/openrpc.json",
            path: "reference",
            sidebarLabel: "JSON-RPC API",
          },
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],
  plugins: [
    [
      "@docusaurus/plugin-content-docs",
      ({
        id: "snaps",
        path: "snaps",
        routeBasePath: "snaps",
        editUrl: "https://github.com/MetaMask/metamask-docs/edit/main/",
        sidebarPath: require.resolve("./snaps-sidebar.js"),
        breadcrumbs: false,
        remarkPlugins: [
          require("remark-docusaurus-tabs"),
        ],
        admonitions: {
          tag: ":::",
          keywords: [
            "info",
            "success",
            "danger",
            "note",
            "tip",
            "warning",
            "important",
            "caution",
            "security",
            "flaskOnly",
          ],
        },
      }),
    ],
    [
      "docusaurus-plugin-typedoc",
      {
        entryPoints: ["./external/keyring-api/src/index.ts"],
        tsconfig: "./external/keyring-api/tsconfig.json",
        readme: "snaps/reference/keyring-api-index/index.md",
        out: path.join(__dirname, "snaps/reference/keyring-api"),
        sidebar: {
          filteredIds: ["reference/keyring-api/index"],
        },
        useCodeBlocks: true,
        expandObjects: true,
        parametersFormat: "table",
        hideGenerator: true,
      },
    ],
    [
      "@docusaurus/plugin-client-redirects",
      {
        fromExtensions: ["html", "htm"],
        redirects: [
          {
            from: "/guide/",
            to: "/wallet/",
          },
          {
            from: "/guide/getting-started",
            to: "/wallet/how-to/get-started-building/set-up-dev-environment",
          },
          {
            from: "/guide/common-terms",
            to: "/wallet/",
          },
          {
            from: "/guide/initializing-dapps",
            to: "/wallet/how-to/interact-with-smart-contracts",
          },
          {
            from: "/guide/accessing-accounts",
            to: "/wallet/how-to/connect/access-accounts",
          },
          {
            from: "/guide/sending-transactions",
            to: "/wallet/how-to/send-transactions",
          },
          {
            from: "/guide/ethereum-provider",
            to: "/wallet/reference/provider-api",
          },
          {
            from: "/guide/provider-migration",
            to: "/wallet/concepts/apis",
          },
          {
            from: "/guide/rpc-api",
            to: "/wallet/reference/json-rpc-api",
          },
          {
            from: "/guide/signing-data",
            to: "/wallet/how-to/sign-data",
          },
          {
            from: "/guide/registering-function-names",
            to: "/wallet/how-to/display/method-names",
          },
          {
            from: "/guide/registering-your-token",
            to: "/wallet/how-to/display/tokens",
          },
          {
            from: "/guide/defining-your-icon",
            to: "/wallet/how-to/display/icon",
          },
          {
            from: "/guide/onboarding-library",
            to: "/wallet/how-to/onboard-users",
          },
          {
            from: "/guide/metamask-extension-provider",
            to: "/wallet/how-to/access-provider",
          },
          {
            from: "/guide/mobile-getting-started",
            to: "/wallet/how-to/connect/set-up-sdk",
          },
          {
            from: "/guide/site-compatibility-checklist",
            to: "/wallet/how-to/connect/set-up-sdk",
          },
          {
            from: "/guide/mobile-best-practices",
            to: "/wallet/how-to/connect/set-up-sdk",
          },
          {
            from: "/guide/snaps",
            to: "/snaps/",
          },
          {
            from: "/guide/snaps-development-guide",
            to: "/snaps/how-to/develop-a-snap",
          },
          {
            from: "/guide/snaps-concepts",
            to: "/snaps/concepts",
          },
          {
            from: "/guide/snaps-rpc-api",
            to: "/snaps/reference/rpc-api",
          },
          {
            from: "/guide/snaps-permissions",
            to: "/snaps/how-to/request-permissions",
          },
          {
            from: "/guide/snaps-exports",
            to: "/snaps/reference/exports",
          },
          {
            from: "/guide/snaps-patching-dependencies",
            to: "/snaps/how-to/troubleshoot",
          },
          {
            from: "/guide/create-dapp",
            to: "/wallet/how-to/get-started-building/set-up-dev-environment",
          },
          {
            from: "/guide/contributors",
            to: "/wallet/",
          },
          {
            from: "/wallet/tutorials/simple-react-dapp",
            to: "/wallet/tutorials/react-dapp-local-state",
          },
          {
            from: "/wallet/category/how-to",
            to: "/wallet/how-to",
          },
          {
            from: "/wallet/category/concepts",
            to: "/wallet/concepts",
          },
          {
            from: "/wallet/category/tutorials",
            to: "/wallet/tutorials",
          },
          {
            from: "/wallet/category/reference",
            to: "/wallet/reference",
          },
          {
            from: "/snaps/category/get-started",
            to: "/snaps/get-started",
          },
          {
            from: "/snaps/category/how-to",
            to: "/snaps/how-to",
          },
          {
            from: "/snaps/category/concepts",
            to: "/snaps/concepts",
          },
          {
            from: "/snaps/category/tutorials",
            to: "/snaps/tutorials",
          },
          {
            from: "/snaps/category/reference",
            to: "/snaps/reference",
          },
          {
            from: "/wallet/category/get-started",
            to: "/wallet/how-to/get-started-building",
          },
          {
            from: "/wallet/get-started/set-up-dev-environment",
            to: "/wallet/how-to/get-started-building/set-up-dev-environment",
          },
          {
            from: "/wallet/get-started/run-development-network",
            to: "/wallet/how-to/get-started-building/run-devnet",
          },
          {
            from: "/wallet/how-to/secure-dapp",
            to: "/wallet/how-to/get-started-building/secure-dapp",
          },
          {
            from: "/wallet/get-started/detect-metamask",
            to: "/wallet/how-to/connect/detect-metamask",
          },
          {
            from: "/wallet/get-started/detect-network",
            to: "/wallet/how-to/connect/detect-network",
          },
          {
            from: "/wallet/get-started/access-accounts",
            to: "/wallet/how-to/connect/access-accounts",
          },
          {
            from: "/wallet/how-to/use-siwe",
            to: "/wallet/how-to/sign-data/siwe",
          },
          {
            from: "/wallet/how-to/use-mobile",
            to: "/wallet/how-to/connect/set-up-sdk",
          },
          {
            from: "/wallet/how-to/use-onboarding-library",
            to: "/wallet/how-to/onboard-users",
          },
          {
            from: "/wallet/how-to/register-token",
            to: "/wallet/how-to/display/tokens",
          },
          {
            from: "/wallet/how-to/register-method-names",
            to: "/wallet/how-to/display/method-names",
          },
          {
            from: "/wallet/how-to/set-icon",
            to: "/wallet/how-to/display/icon",
          },
          {
            from: "/wallet/concepts/provider-api",
            to: "/wallet/concepts/apis",
          },
          {
            from: "/wallet/concepts/rpc-api",
            to: "/wallet/concepts/apis",
          },
          {
            from: "/wallet/how-to/integrate-with-mobile",
            to: "/wallet/how-to/connect/set-up-sdk",
          },
          {
            from: "/wallet/how-to/migrate-api",
            to: "/wallet/concepts/apis",
          },
          {
            from: "/sdk",
            to: "/wallet/how-to/connect/set-up-sdk",
          },
          {
            from: "/wallet/reference/rpc-api",
            to: "/wallet/reference/json-rpc-api",
          },
        ].reduce((acc, item) => {
          acc.push(item);
          acc.push({ from: item.from + ".html", to: item.to });
          return acc;
        }, []),
        createRedirects(existingPath) {
          if (existingPath.includes("/connect/set-up-sdk")) {
            return [
              existingPath.replace("/connect/set-up-sdk", "/use-sdk"),
            ];
          }
          return undefined;
        },
      },
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: " │ ‎ Documentation",
        logo: {
          alt: "MetaMask logo",
          src: "img/metamask-logo.svg",
          srcDark: "img/metamask-logo-dark.svg",
          width: 150,
        },
        items: [
          {
            to: "wallet",
            label: "Wallet",
          },
          {
            to: "/wallet/how-to/connect/set-up-sdk",
            label: "SDK",
          },
          {
            to: "snaps",
            label: "Snaps",
          },
        ],
      },
      docs: {
        sidebar: {
          autoCollapseCategories: true,
        },
      },
      footer: {
        logo: {
          alt: "MetaMask logo",
          src: "img/metamask-logo.svg",
          srcDark: "img/metamask-logo-dark.svg",
          href: "https://metamask.io/",
          width: 250,
        },
        links: [
          {
            title: "Documentation",
            items: [
              {
                label: "Home",
                to: "/",
              },
              {
                label: "MetaMask wallet",
                to: "/wallet",
              },
              {
                label: "MetaMask SDK",
                to: "/sdk",
              },
              {
                label: "Snaps",
                to: "/snaps",
              },
            ],
          },
          {
            title: "GitHub",
            items: [
              {
                label: "Documentation GitHub",
                href: "https://github.com/MetaMask/metamask-docs",
              },
              {
                label: "MetaMask wallet GitHub",
                href: "https://github.com/MetaMask/metamask-extension/",
              },
              {
                label: "MetaMask SDK GitHub",
                href: "https://github.com/MetaMask/metamask-sdk/",
              },
              {
                label: "Snaps GitHub",
                href: "https://github.com/MetaMask/snaps-monorepo",
              },
            ],
          },
          {
            title: "Community",
            items: [
              {
                label: "Consensys Discord",
                href: "https://discord.gg/consensys",
              },
              {
                label: "Contribute to MetaMask",
                href: "https://github.com/MetaMask/metamask-extension/blob/develop/docs/README.md",
              },
              {
                label: "Contribute to the docs",
                href: "https://github.com/MetaMask/metamask-docs/blob/main/CONTRIBUTING.md",
              },
            ],
          },
          {
            title: "Legal",
            items: [
              {
                label: "Privacy Policy",
                href: "https://consensys.net/privacy-policy/",
              },
              {
                label: "Terms of Use",
                href: "https://consensys.net/terms-of-use/",
              },
              {
                label: "Contributor License Agreement",
                href: "https://metamask.io/cla/",
              },
              {
                html: "<button id='manage-cookie-btn'>Manage cookies</button>",
              },
            ],
          },
        ],
        copyright: `© ${new Date().getFullYear()} MetaMask • A Consensys Formation`,
      },
      prism: {
        theme: codeTheme,
        additionalLanguages: ["csharp","swift","gradle","kotlin"],
      },
      algolia: {
        // The application ID provided by Algolia
        appId: "AWX4QVM59R",

        // Public API key: it is safe to commit it
        apiKey: "6095a25a6824bfa909fa0692e6847ec4",

        indexName: "mm--v2-staging",

        // Optional: see doc section below
        contextualSearch: true,

        // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
        // externalUrlRegex: "external\\.com|domain\\.com",

        // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
        replaceSearchResultPathname: {
          from:  "/",
          to: process.env.DEST || "/",
        },

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

        // Optional: path for search page that enabled by default (`false` to disable it)
        searchPagePath: "search",

        //... other Algolia params
      },
      mermaid: {
        options: {
          fontFamily: "arial, verdana, sans-serif;",
          wrap: true,
          sequence: {
            diagramMarginX: 25,
            diagramMarginY: 25,
          },
          flowchart: {
            diagramPadding: 5,
            nodeSpacing: 75,
          },
        },
      },
    }),
};

module.exports = config;