docusaurus.config.js

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

const { themes } = require('prism-react-renderer')
const lightCodeTheme = themes.github
const darkCodeTheme = themes.dracula

const projectKey =
  process.env.NODE_ENV === 'production'
    ? 'Uuv6kG5tEsMxJaTbj66ljUoei91qg1La'
    : 'sk_test_uH7GmxPmqXDxpn4x6EXi4V5Hg4PsQFFh'

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'WalletConnect Docs',
  tagline: 'WalletConnect is an open protocol to communicate securely between Dapps and Wallets.',
  url: 'https://docs.walletconnect.com/',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'throw',
  favicon: 'img/favicon.ico',
  organizationName: 'walletconnect',
  projectName: 'walletconnect-docs',
  staticDirectories: ['static'],
  scripts: [
    {
      src: 'https://plausible.io/js/plausible.js',
      defer: true,
      'data-domain': 'docs.walletconnect.com'
    }
  ],
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      {
        docs: {
          breadcrumbs: true,
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
          showLastUpdateTime: true,
          editUrl: 'https://github.com/WalletConnect/walletconnect-docs/blob/main/',
          remarkPlugins: [
            [
              require('@docusaurus/remark-plugin-npm2yarn'),
              {
                sync: true,
                converters: [
                  'yarn',
                  [
                    'Bun',
                    code => code.replace(/npm i /g, 'bun a ').replace(/npm install /g, 'bun add ')
                  ],
                  'pnpm'
                ]
              }
            ]
          ]
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css')
        }
      }
    ]
  ],

  themeConfig: {
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    algolia: {
      appId: 'KEO8ND6AUT',
      apiKey: '5921626237dc9040afc258af25d4e77d',
      indexName: 'walletconnect',
      contextualSearch: true
    },
    image: 'img/Docs-OG.png',
    metadata: [{ name: 'twitter:card', content: 'summary_large_image' }],
    navbar: {
      items: [
        {
          type: 'html',
          value:
            '<a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/walletconnect-logo-white.svg#dark-mode-only"  alt="WalletConnect Logo"><img src="/img/walletconnect-logo-black.svg#light-mode-only"  alt="WalletConnect Logo"></div>WalletConnect<span>Docs<span></a>'
        },
        {
          label: 'Dashboard',
          href: 'https://cloud.walletconnect.com/?utm_source=website&utm_medium=docs&utm_campaign=walletconnectdocs',
          position: 'right',
          className: 'header-cloud-link',
          'aria-label': 'Cloud'
        },
        {
          href: 'https://github.com/walletconnect/',
          position: 'right',
          className: 'header-github-link',
          'aria-label': 'GitHub repository'
        }
      ]
    },
    footer: {
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Web3Modal SDK',
              to: '/web3modal/about'
            },
            {
              label: 'Web3Wallet SDK',
              to: '/web3wallet/about'
            },
            {
              label: 'Web3Inbox SDK',
              to: '/web3inbox/about'
            }
          ]
        },
        {
          title: 'Community',
          items: [
            {
              label: 'GitHub Discussions',
              href: 'https://github.com/WalletConnect/walletconnect-monorepo/discussions'
            },
            {
              label: 'Discord',
              href: 'https://discord.com/invite/kdTQHQ6AFQ'
            },
            {
              label: 'Telegram',
              href: 'https://t.me/walletconnect'
            },
            {
              label: 'X',
              href: 'https://twitter.com/walletconnect'
            }
          ]
        },
        {
          title: 'More',
          items: [
            {
              label: 'Blog',
              href: 'https://medium.com/walletconnect'
            },
            {
              label: 'GitHub',
              href: 'https://github.com/walletconnect/walletconnect-docs/'
            },
            {
              label: 'Farcaster',
              href: 'https://warpcast.com/walletconnect/'
            }
          ]
        }
      ],
      copyright: `Copyright © ${new Date().getFullYear()} WalletConnect, Inc.`
    },
    colorMode: {
      defaultMode: 'dark',
      disableSwitch: false,
      respectPrefersColorScheme: false
    },
    prism: {
      darkTheme: darkCodeTheme,
      theme: lightCodeTheme,
      additionalLanguages: ['swift', 'kotlin', 'dart', 'csharp', 'gradle', 'ruby'],
      magicComments: [
        {
          className: 'theme-code-block-highlighted-delete',
          line: 'highlight-delete',
          block: { start: 'highlight-delete-start', end: 'highlight-delete-end' }
        },
        {
          className: 'theme-code-block-highlighted-add',
          line: 'highlight-add',
          block: { start: 'highlight-add-start', end: 'highlight-add-end' }
        }
      ]
    },
    announcementBar: {
      id: 'support_us',
      content:
        'It’s shipping szn 🚢 Explore Web3Modal’s latest features: Email Wallets and On-ramp! <a rel="noopener noreferrer" href="/web3modal/features/onramp">Read the docs</a>',
      backgroundColor: '#3182ce',
      textColor: '#fff',
      isCloseable: true
    }
  }
}

module.exports = config