docusaurus.config.js

/** @type {import('@docusaurus/types').DocusaurusConfig} */
const path = require("path");
const math = require("remark-math");
const katex = require("rehype-katex");
const { docs, developers } = require("./sidebars");
const DefaultLocale = "en";

module.exports = {
  title: "Celo Documentation",
  tagline: "Documentation for the Celo platform.",
  url: "https://docs.celo.org",
  baseUrl: "/",
  trailingSlash: false,
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/color-favicon.png",
  organizationName: "celo-org", // Usually your GitHub org/user name.
  projectName: "docs", // Usually your repo name.
  //  i18n: {
  //    defaultLocale: "en",
  //    locales: ["en", "es"],
  //  },
  themes: ["@docusaurus/theme-live-codeblock"],
  scripts: [
    {
      src: "https://cdnjs.cloudflare.com/ajax/libs/web3/1.6.0/web3.min.js",
      async: true,
    },
  ],
  plugins: [
    require.resolve("docusaurus-plugin-hubspot"),
    require.resolve("docusaurus-plugin-fathom"),
    path.resolve(__dirname, "src/plugins/aliases.ts"),
    path.resolve(__dirname, "src/plugins/web3-polyfill.ts"),
    [
      "@docusaurus/plugin-client-redirects",
      {
        redirects: [
          {
            to: "/celo-owner-guide/ledger",
            from: [
              "/operations-manual/key-management/using-a-ledger-wallet",
              "/operations-manual/key-management/ledger",
              "/operations-manual/summary/ledger",
              "/operations-manual/using-a-ledger-wallet",
              "/validator-guide/key-management/using-a-ledger-wallet",
              "/validator-guide/key-management/ledger",
              "/validator-guide/summary/ledger",
              "/validator-guide/using-a-ledger-wallet",
              "/celo-gold-holder-guide/ledger",
            ],
          },
          {
            to:
              "/getting-started/baklava-testnet/running-a-full-node-in-baklava",
            from: [
              "/getting-started/running-a-full-node",
              "/getting-started/running-a-validator",
              "/getting-started/running-a-full-node-in-baklava",
            ],
          },
          {
            to: "/getting-started/using-the-wallet",
            from: ["/getting-started/using-the-mobile-wallet"],
          },
          {
            to: "/celo-owner-guide/release-gold",
            from: [
              "/celo-codebase/protocol/release-gold",
              "/celo-holder-guide/release-gold",
              "/celo-gold-holder-guide/release-gold",
            ],
          },
          {
            to: "/developer-guide/start",
            from: [
              "/developer-guide/start/celo-truffle-box",
              "/developer-resources/walkthroughs/hello-mobile-dapp",
            ],
          },
          {
            to: "/developer-guide/overview",
            from: [
              "/developer-guide/overview/introduction",
              "/developer-resources/overview",
            ],
          },
          {
            to: "/developer-guide/development-chain",
            from: ["/developer-guide/start/development-chain"],
          },
          {
            to: "/important-information/mainnet-network-disclaimer",
            from: ["/important-information/rc-network-disclaimer"],
          },
          {
            to: "/getting-started/mainnet",
            from: ["/getting-started/rc1"],
          },
          {
            to: "/getting-started/mainnet/running-a-full-node-in-mainnet",
            from: [
              "/getting-started/rc1/running-a-full-node-in-rc1",
              "/getting-started/running-a-full-node-in-mainnet",
            ],
          },
          {
            to: "/getting-started/mainnet/running-a-validator-in-mainnet",
            from: [
              "/getting-started/rc1/running-a-validator-in-rc1",
              "/getting-started/running-a-validator-in-mainnet",
            ],
          },
          {
            to: "/celo-owner-guide/quick-start",
            from: [
              "/celo-gold-holder-guide/quick-start",
              "/celo-holder-guide/quick-start",
            ],
          },
          {
            to: "/celo-owner-guide/voting-governance",
            from: [
              "/celo-gold-holder-guide/voting-governance",
              "/celo-holder-guide/voting-governance",
            ],
          },
          {
            to: "/celo-owner-guide/voting-validators",
            from: [
              "/celo-gold-holder-guide/voting-validators",
              "/celo-holder-guide/voting-validators",
            ],
          },
          {
            to: "/celo-owner-guide/cusd",
            from: ["/celo-holder-guide/cusd"],
          },
          {
            to: "/celo-owner-guide/eth-recovery",
            from: ["/celo-holder-guide/eth-recovery"],
          },
          {
            to: "/celo-owner-guide/celo-recovery",
            from: ["/celo-holder-guide/celo-recovery"],
          },
          {
            to: "/developer-guide/overview",
            from: ["/v/master/developer-guide/overview"],
          },
          {
            to: "/developer-guide/start",
            from: ["/v/master/developer-guide/start"],
          },
          {
            to: "/command-line-interface/account",
            from: ["/command-line-interface/commands/account"],
          },
          {
            to: "/command-line-interface/autocomplete",
            from: ["/command-line-interface/commands/autocomplete"],
          },
          {
            to: "/command-line-interface/commands",
            from: ["/command-line-interface/commands/commands"],
          },
          {
            to: "/command-line-interface/config",
            from: ["/command-line-interface/commands/config"],
          },
          {
            to: "/command-line-interface/dkg",
            from: ["/command-line-interface/commands/dkg"],
          },
          {
            to: "/command-line-interface/election",
            from: ["/command-line-interface/commands/election"],
          },
          {
            to: "/command-line-interface/exchange",
            from: ["/command-line-interface/commands/exchange"],
          },
          {
            to: "/command-line-interface/governance",
            from: ["/command-line-interface/commands/governance"],
          },
          {
            to: "/command-line-interface/help",
            from: ["/command-line-interface/commands/help"],
          },
          {
            to: "/command-line-interface/identity",
            from: ["/command-line-interface/commands/identity"],
          },
          {
            to: "/command-line-interface/lockedgold",
            from: ["/command-line-interface/commands/lockedgold"],
          },
          {
            to: "/command-line-interface/multisig",
            from: ["/command-line-interface/commands/multisig"],
          },
          {
            to: "/command-line-interface/network",
            from: ["/command-line-interface/commands/network"],
          },
          {
            to: "/command-line-interface/node",
            from: ["/command-line-interface/commands/node"],
          },
          {
            to: "/command-line-interface/oracle",
            from: ["/command-line-interface/commands/oracle"],
          },
          {
            to: "/command-line-interface/plugins",
            from: ["/command-line-interface/commands/plugins"],
          },
          {
            to: "/command-line-interface/introduction",
            from: [
              "/command-line-interface/commands/registry",
              "/command-line-interface/registry",
            ],
          },
          {
            to: "/command-line-interface/releasegold",
            from: ["/command-line-interface/commands/releasegold"],
          },
          {
            to: "/command-line-interface/reserve",
            from: ["/command-line-interface/commands/reserve"],
          },
          {
            to: "/command-line-interface/rewards",
            from: ["/command-line-interface/commands/rewards"],
          },
          {
            to: "/command-line-interface/transfer",
            from: ["/command-line-interface/commands/transfer"],
          },
          {
            to: "/command-line-interface/validator",
            from: ["/command-line-interface/commands/validator"],
          },
          {
            to: "/command-line-interface/validatorgroup",
            from: ["/command-line-interface/commands/validatorgroup"],
          },
          {
            to: "/celo-codebase/protocol/odis/use-cases/phone-number-privacy",
            from: ["/celo-codebase/protocol/identity/phone-number-privacy"],
          },
          {
            to: "/celo-codebase/protocol/identity/smart-contract-accounts",
            from: ["/celo-codebase/protocol/identity/valora-accounts"],
          },
        ],
      },
    ],
    [
      "ideal-image",
      /** @type {import('@docusaurus/plugin-ideal-image').PluginOptions} */
      ({
        quality: 70,
        max: 1030,
        min: 640,
        steps: 2,
        // Use false to debug, but it incurs huge perf costs
        disableInDev: true,
      }),
    ],
  ],
  themeConfig: {
    announcementBar: {
      id: "support_us",
      content:
        '🌱 If you like Celo, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/celo-org/celo-monorepo">GitHub</a> and follow <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/CeloDevs">@CeloDevs</a> and <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/CeloOrg">@CeloOrg </a> 🌱',
      backgroundColor: "#18191A",
      textColor: "#ffffff",
      isCloseable: false,
    },
    docs: {
      sidebar: { hideable: true },
    },
    prism: {
      additionalLanguages: ["solidity"],
      theme: require("prism-react-renderer/themes/dracula"),
    },
    colorMode: {
      defaultMode: "dark",
    },
    navbar: {
      title: "Celo Docs",
      logo: {
        alt: "Celo Logo",
        src: "img/color-logo.png",
      },
      items: [
        // {
        //     "to": "welcome",
        //     "label": "Basics",
        //     "position": "left"
        // },
        {
          to: "developer-guide/overview",
          label: "Developers",
          position: "left",
        },
        {
          to: "validator-guide/overview",
          label: "Validators",
          position: "left",
        },
        {
          to: "developer-guide/integrations",
          label: "Integrations",
          position: "left",
        },
        // {
        //   to: "/community/contributing",
        //   label: "Stake",
        //   position: "left",
        // },
        // {
        //   to: "/blog",
        //   label: "Learn",
        //   position: "left",
        // },
        { to: "showcase", label: "Showcase", position: "left" },
        {
          to: "/blog",
          label: "Tutorials",
          position: "left",
        },
        // {
        //   type: "dropdown",
        //   position: "left",
        //   label: "Tutorials",
        //   items: [
        //     {
        //       label: "Code Tutorials",
        //       to: "blog",
        //     },
        //     {
        //       label: "Developer Blog",
        //       to: "https://medium.com/celodevelopers/",
        //     },
        //     {
        //       label: "EVM Basics",
        //       to: "https://ethereum.org/en/developers/docs/",
        //     },
        //     {
        //       label: "Celo Blog",
        //       to: "https://medium.com/celoorg",
        //     },
        //     {
        //       label: "Figment",
        //       to: "https://learn.figment.io/protocols/celo",
        //     },
        //     {
        //       label: "Dacade",
        //       to: "https://dacade.org/communities/celo",
        //     },
        //   ],
        // },
        // {
        //   type: "localeDropdown",
        //   position: "right",
        //   dropdownItemsAfter: [
        //     {
        //       to: "https://celo.crowdin.com/",
        //       label: "Help us translate",
        //     },
        //   ],
        // },
        {
          type: "dropdown",
          position: "right",
          label: "Support",
          items: [
            {
              to: "https://forum.celo.org/",
              label: "View the Forum",
            },
            {
              to: "https://github.com/celo-org/docs/issues/new",
              label: "Create an Issue",
            },
          ],
        },
        {
          type: "dropdown",
          position: "right",
          label: "APIs & SDKs",
          items: [
            { to: "command-line-interface/introduction", label: "CLI" },
            {
              to: "https://celo-sdk-docs.readthedocs.io/en/latest/",
              label: "SDK",
            },
            {
              to: "https://github.com/heymateag/celoiossdk",
              label: "iOS",
            },
            {
              to: "https://github.com/blaize-tech/celo-sdk-java",
              label: "Java",
            },
            { to: "https://github.com/celo-org/react-celo", label: "React" },
            { to: "https://docs.flutter.dev/", label: "Flutter" },
            {
              to: "https://github.com/blaize-tech/celo-sdk-py/",
              label: "Python",
            },
            {
              to:
                "https://github.com/celo-org/celo-monorepo/tree/master/packages/sdk/contractkit",
              label: "JavaScript",
            },
            {
              to:
                "https://github.com/celo-org/celo-composer/tree/main/packages/react-native-app",
              label: "React Native",
            },
            {
              label: "Celo Composer",
              to: "https://github.com/celo-org/celo-composer#celo-composer",
            },
          ],
        },
        {
          href: "https://github.com/celo-org",
          position: "right",
          className: "header-github-link",
          "aria-label": "GitHub repository",
        },
      ],
    },
    algolia: {
      appId: "55M4I38S60",
      apiKey: "baed78b52be14ac907688f1dd70b41d5",
      indexName: "celo",
      contextualSearch: true,
      debug: false,
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Docs",
          items: [
            {
              label: "Home",
              to: "/",
            },
            {
              label: "Blog",
              to: "/blog",
            },
            // {
            //   href: "https://celo.crowdin.com/celo-docs",
            //   label: "Help translate",
            // },
            {
              label: "Docs GitHub",
              href: "https://github.com/celo-org/docs",
            },
          ],
        },
        {
          title: "Community",
          items: [
            {
              href: "/community/contributing",
              label: "Contributors",
            },
            {
              label: "Forum",
              href: "https://forum.celo.org/",
            },
            {
              label: "Discord",
              href: "https://chat.celo.org",
            },
            {
              label: "Twitter",
              href: "https://twitter.com/CeloOrg",
            },
            {
              label: "Reddit",
              href: "https://www.reddit.com/r/celo/",
            },
            {
              label: "Celo GitHub",
              href: "https://github.com/celo-org",
            },
          ],
        },
        {
          title: "Ecosystem",
          items: [
            {
              label: "Celo Foundation",
              href: "https://celo.org",
            },
            {
              label: "Medium Blog",
              href: "https://medium.com/celoorg",
            },
            {
              label: "The Celo",
              href: "https://thecelo.com/",
            },
            {
              label: "Celo Hub",
              href: "https://celohub.org/",
            },
            {
              label: "Careers",
              href: "https://celo.org/jobs",
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Celo Foundation, Inc. Built with Docusaurus.`,
    },
    fathomAnalytics: {
      siteId: "AZMFWALB",
    },
    hubspot: {
      accountId: 8568019,
    },
  },
  presets: [
    [
      "@docusaurus/preset-classic",
      {
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          // Please change this to your repo.
          editUrl: "https://github.com/celo-org/docs/edit/main/",
          editUrl: ({ locale, versionDocsDirPath, docPath }) => {
            // Link to Crowdin for French docs
            if (locale !== DefaultLocale) {
              return `https://celo.crowdin.com/celo-docs/${locale}`;
            }
            // Link to Github for English docs
            return `https://github.com/celo-org/docs/edit/main/docs/${docPath}`;
          },
          routeBasePath: "/",
          remarkPlugins: [
            math,
            [require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
            require("mdx-mermaid"),
          ],
          rehypePlugins: [katex],
        },
        gtag: {
          // You can also use your "G-" Measurement ID here.
          trackingID: "G-0CXEKQ81V2",
          // Optional fields.
          anonymizeIP: true, // Should IPs be anonymized?
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        blog: {
          blogTitle: "Celo Tutorials",
          blogSidebarTitle: "All posts",
          // blogSidebarCount: "ALL",
          showReadingTime: false,
          blogListComponent: require.resolve(
            "./src/components/CustomBlogListPage.module.tsx"
          ),
          readingTime: ({ content, frontMatter, defaultReadingTime }) =>
            // allows per post reading time override in frontmatter
            frontMatter.hide_reading_time
              ? undefined
              : defaultReadingTime({
                  content,
                  options: { wordsPerMinute: 300 },
                }),
        },
      },
    ],
  ],
  stylesheets: [
    {
      href: "https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css",
      integrity:
        "sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc",
      crossorigin: "anonymous",
    },
  ],
};