docusaurus.config.js

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

require('dotenv').config();

const { themes } = require('prism-react-renderer');

const BIEL_PROJECT = 'w30c27l8fg';
const BIEL_WARNING = 'AI-generated answers may contain errors. Verify the information before use. For more information, see <a href="https://docs.etherlink.com/overview/chatbot">Using the chatbot</a>.';

const POSTHOG_ASSETS = 'https://us-assets.i.posthog.com';
const POSTHOG_API = 'https://us.i.posthog.com';

// script-src causes development builds to fail
// But unsafe-eval should NOT be in production builds
// Also, put GTM first because sometimes the ';' in the escaped single quotes causes the browser to think it's the end
const scriptSrc =
  process.env.NODE_ENV === 'development'
    ? `https://*.google.com https://*.gstatic.com https://*.googletagmanager.com https://cdn.jsdelivr.net ${POSTHOG_ASSETS} 'self' 'unsafe-inline' 'unsafe-eval'`
    : `https://*.google.com https://*.gstatic.com https://*.googletagmanager.com https://cdn.jsdelivr.net ${POSTHOG_ASSETS} 'self' 'unsafe-inline'`;


const contentSecurityPolicy = `
default-src 'none';
base-uri 'self';
manifest-src 'self';
script-src ${scriptSrc};
style-src https://cdn.jsdelivr.net https://fonts.googleapis.com 'self' 'unsafe-inline';
font-src https://cdn.jsdelivr.net https://fonts.gstatic.com 'self';
img-src 'self' https://*.googletagmanager.com https://*.google-analytics.com data: https://*.walletconnect.com ${POSTHOG_API};
media-src 'self';
form-action 'self';
connect-src 'self' ${POSTHOG_API} https://*.google.com https://cdn.jsdelivr.net https://node.mainnet.etherlink.com https://node.shadownet.etherlink.com https://*.thirdweb.com https://*.algolia.net https://*.algolianet.com https://app.pushfeedback.com https://*.googletagmanager.com https://*.google-analytics.com https://*.analytics.google.com https://*.walletconnect.com https://*.walletconnect.org wss://relay.walletconnect.org wss://app.biel.ai https://app.biel.ai;
frame-src https://*.google.com https://tezosbot.vercel.app https://*.loom.com https://*.thirdweb.com https://*.walletconnect.org;
`;

/** @type {import('@docusaurus/types').Config} */
module.exports = async function createConfigAsync() {
  return {
    title: 'Etherlink documentation',
    tagline: 'Etherlink builds on the decentralisation of L1 Tezos to provide an EVM-compatible solution with distributed sequencing.',
    favicon: '/img/site/favicon.svg',
    url: 'https://docs.etherlink.com',
    baseUrl: '/',
    organizationName: 'etherlinkcom',
    projectName: 'docs',
    onBrokenLinks: 'throw',
    i18n: {
      defaultLocale: 'en',
      locales: ['en'],
    },
    markdown: {
      mermaid: true,
      hooks: {
        onBrokenMarkdownLinks: 'warn',
      }
    },
    future: {
      // Granular v4 opt-in. We adopt the safe v4 defaults but intentionally
      // leave two off until the repo is ready:
      //   - fasterByDefault (Rspack): docusaurus-node-polyfills pushes a webpack
      //     ProvidePlugin that Rspack 1.7 rejects.
      //   - mdx1CompatDisabledByDefault: many pages use <!--TX--> HTML comments,
      //     which strict MDX rejects.
      // `v4: true` would enable all five and break the build on 3.10.
      v4: {
        useCssCascadeLayers: true,
        siteStorageNamespacing: true,
        removeLegacyPostBuildHeadAttribute: true,
      },
    },

    customFields: {
      THIRDWEB_CLIENT_ID: process.env.THIRDWEB_CLIENT_ID,
    },

    headTags: [
      {
        tagName: 'meta',
        attributes: {
          'http-equiv': 'Content-Security-Policy',
          content: contentSecurityPolicy,
        },
      },
    ],

    themes: ['@docusaurus/theme-mermaid'],

    presets: [
      [
        'classic',
        /** @type {import('@docusaurus/preset-classic').Options} */
        ({
          docs: {
            sidebarPath: require.resolve('./sidebars.js'),
            routeBasePath: '/', // Serve the docs at the site's root
            remarkPlugins: [(await import('remark-math')).default],
            rehypePlugins: [(await import('rehype-katex')).default],
            showLastUpdateTime: true,
          },
          blog: false,
          theme: {
            customCss: require.resolve('./src/css/custom.css'),
          },
          gtag: {
            trackingID: 'G-7GJCKRZ8V9',
            anonymizeIP: false,
          },
        }),
      ],
    ],

    plugins: [
      'plugin-image-zoom',
      'docusaurus-node-polyfills',
      [
        'docusaurus-pushfeedback', {
          project: 'zh2wgyi1d7',
        },
      ],
      require.resolve('./src/plugins/webpack-config-plugin'),
      require.resolve('./src/plugins/llms-txt-plugin'),
      [
        '@docusaurus/plugin-client-redirects',
        {
          createRedirects(existingPath) {
            const prefixMap = [
              // first, individual files:
              ['/overview/chatbot', '/get-started/chatbot'],
              ['/testing/sandbox', '/building-on-etherlink/sandbox'],
              ['/testing/testnet', '/building-on-etherlink/testnet'],
              ['/testing/migrating-testnet', '/network/migrating-testnet'],
              ['/evm/developing/fees', '/network/fees'],
              // then, whole directories:
              ['/evm/get-started/', '/get-started/'],
              ['/evm/developing/', '/building-on-etherlink/'],
              ['/evm/bridging/', '/bridging/'],
              ['/evm/tools/', '/tools/'],
            ];
            for (const [newPrefix, oldPrefix] of prefixMap) {
              if (existingPath.startsWith(newPrefix)) {
                return [existingPath.replace(newPrefix, oldPrefix)];
              }
            }
            return undefined;
          },
        },
      ],
      [
        'docusaurus-biel',{
          project: BIEL_PROJECT,
          headerTitle: 'Etherlink/Tezos documentation chatbot (beta)',
          buttonPosition: 'center-right',
          version: 'latest',
          suggestedQuestions: [
            'What development tools does Etherlink support?',
            'What assets can I bridge to Etherlink?',
          ],
          welcomeMessage: "Hi! How can I help you learn about Etherlink and Tezos?",
          footerText: BIEL_WARNING,
        },
      ],
    ],

    themeConfig:
      /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
      ({
        colorMode: {
          defaultMode: "dark",
          disableSwitch: true,
          respectPrefersColorScheme: false,
        },
        mermaid: {
          options: {
            // Match the site font (custom.css sets Roboto globally).
            fontFamily: 'Roboto, sans-serif',
            // Render flowchart labels as native SVG text: with the default
            // HTML labels, mermaid sizes the node boxes from an off-screen
            // measurement that comes out ~10% narrower than the final DOM
            // layout, so labels get clipped ("Etherlink cha…").
            // htmlLabels must be disabled both at the top level and per
            // diagram type — mermaid 11 reads both.
            htmlLabels: false,
            flowchart: {
              htmlLabels: false,
            },
          },
        },
        // Replace with your project's social card
        image: 'img/site/etherlink-social-card.png',
        navbar: {
          // style: 'primary',
          // title: 'Etherlink documentation',
          // logo: {
          //   alt: 'Etherlink developer documentation',
          //   src: '/img/Etherlink-Docs-Logo.svg',
          // },
          items: [
            {
              type: 'search',
              position: 'left'
            },
            {
              href: 'https://github.com/etherlinkcom/docs',
              position: 'right',
              className: 'github-link',
              "aria-label": "Github repository (docs)",
            },
            {
              to: 'https://x.com/etherlink',
              position: 'right',
              target: '_blank',
              className: 'x-link',
            },
            {
              to: 'https://discord.gg/etherlink',
              position: 'right',
              target: '_blank',
              className: 'discord-link',
            },
          ],
        },
        prism: {
          theme: themes.github,
          darkTheme: themes.dracula,
          additionalLanguages: ['solidity', 'bash', 'shell-session'],
        },
        docs: {
          sidebar: {
            autoCollapseCategories: true,
          },
        },
        // https://github.com/flexanalytics/plugin-image-zoom
        // Enable click to zoom in to large images
        imageZoom: {
          // CSS selector to apply the plugin to, defaults to '.markdown img'
          selector: '.markdown img',
          // Optional medium-zoom options
          // see: https://www.npmjs.com/package/medium-zoom#options
          options: {
            margin: 24,
            scrollOffset: 0,
          },
        },
        algolia: {
          // The application ID provided by Algolia
          appId: process.env.NEXT_PUBLIC_DOCSEARCH_APP_ID || "PM6ZQ764IP",
          // Public API key: it is safe to commit it
          apiKey: process.env.NEXT_PUBLIC_DOCSEARCH_API_KEY || "c652d71679eec3859b7064047793bab2",
          indexName: process.env.NEXT_PUBLIC_DOCSEARCH_INDEX_NAME || "etherlink",
          // 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: '/docs/', // or as RegExp: /\/docs\//
          //   to: '/',
          // },
          // Optional: Algolia search parameters
          // searchParameters: {},
          // Optional: path for search page that enabled by default (`false` to disable it)
          searchPagePath: false,
          disableUserPersonalization: true,
          //... other Algolia params
        },
      }),
    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',
      },
    ],
    scripts: [
      {
        src: '/js/posthog.js',
        defer: true,
      },
    ],
  }
};