docusaurus.config.js

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

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Tracetest Docs',
  tagline: 'Trace-based testing',
  url: 'https://docs.tracetest.io',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/logo.svg',

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

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

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: "https://github.com/kubeshop/tracetest/blob/main/docs/",
          routeBasePath: "/",
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        sitemap: {
          changefreq: 'always',
          priority: 0.5,
          ignorePatterns: ['/tags/**'],
          filename: 'sitemap.xml',
        },
      }),
    ],
    [
      "redocusaurus",
      {
        // Plugin Options for loading OpenAPI files
        specs: [
          {
            spec: "https://raw.githubusercontent.com/kubeshop/tracetest/main/api/openapi.yaml",
            route: "/openapi/",
          },
        ],
        // Theme Options for modifying how redoc renders them
        theme: {
          // Change with your site colors
          primaryColor: "#1890ff",
        },
      },
    ],
  ],
  plugins: [
    // [
    //   '@docusaurus/plugin-google-gtag',
    //   {
    //     trackingID: 'G-999X9XX9XX',
    //     anonymizeIP: true,
    //   },
    // ],
    [
      '@docusaurus/plugin-ideal-image',
      {
        quality: 70,
        max: 1030, // max resized image's size.
        min: 640, // min resized image's size. if original is lower, use that size.
        steps: 2, // the max number of images generated between min and max (inclusive)
        disableInDev: false,
      },
    ],
    [
      require.resolve('docusaurus-gtm-plugin'),
      {
        id: 'GTM-MZ7RNS7', // GTM Container ID
      },
    ],
    [
      '@docusaurus/plugin-client-redirects',
      {
        // fromExtensions: ['html', 'htm'], // /myPage.html -> /myPage
        // toExtensions: ['exe', 'zip'], // /myAsset -> /myAsset.zip (if latter exists)
        redirects: [
          // /docs/oldDoc -> /docs/newDoc
          // {
          //   to: '/using-tracetest/adding-assertions',
          //   from: '/adding-assertions',
          // },
          // Redirect from multiple old paths to the new path
          // {
          //   to: '/cli/test-definition-file', // replace with '/cli/creating-tests' after new docs structure release
          //   from: ['/test-definition-file' /*, '/docs/legacyDocFrom2016'*/],
          // },
          {
            to: '/',
            from: ['/introduction' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/concepts/selectors',
            from: ['/advanced-selectors' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/core/deployment/docker',
            from: ['/deployment/overview/docker', '/deployment/docker' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/core/deployment/kubernetes',
            from: ['/deployment/overview/kubernetes', '/deployment/kubernetes' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/getting-started/installation',
            from: ['/getting-started/cli', '/getting-started/detailed-installation', '/installing' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/getting-started/open',
            from: ['/accessing-dashboard' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/configuration/overview',
            from: ['/getting-started/supported-backends' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/web-ui/creating-tests',
            from: ['/using-tracetest/create-test' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/web-ui/test-results',
            from: ['/using-tracetest/test-results' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/web-ui/creating-test-specifications',
            from: ['/using-tracetest/adding-assertions' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/concepts/versioning',
            from: ['/using-tracetest/versioning' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/cli/creating-tests',
            from: ['/cli/test-definition-file', '/test-definition-file' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/cli/configuring-your-cli/',
            from: ['/cli/command-line-tool' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/ci-cd-automation/github-actions-pipeline',
            from: ['/ci-cd-automation/ci-cd-best-practices' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/tools-and-integrations/k6',
            from: ['/tools-and-integrations/integrations/k6' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/tools-and-integrations/keptn',
            from: ['/tools-and-integrations/integrations/keptn' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/tools-and-integrations/testkube',
            from: ['/tools-and-integrations/integrations/testkube' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/ci-cd-automation/testkube-pipeline',
            from: ['/examples-tutorials/recipes/running-tracetest-with-testkube' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/ci-cd-automation/tekton-pipeline',
            from: ['/examples-tutorials/recipes/running-tracetest-with-tekton' /*, '/docs/legacyDocFrom2016'*/],
          },
          {
            to: '/analyzer/concepts',
            from: ['/concepts/tracetest-analyzer-concepts'],
          },
          {
            to: '/cli/cli-installation-reference',
            from: ['/getting-started/cli-installation-reference'],
          },
          {
            to: '/cli/creating-test-suites',
            from: ['/cli/creating-transactions'],
          },
          {
            to: '/concepts/test-suites',
            from: ['/concepts/transactions'],
          },
          {
            to: '/web-ui/creating-test-suites',
            from: ['/web-ui/creating-transactions'],
          },
          {
            to: '/web-ui/creating-tests',
            from: ['/create-test'],
          },
          {
            to: '/web-ui/creating-test-specifications',
            from: ['/adding-assertions'],
          },
          {
            to: '/web-ui/test-results',
            from: ['/test-results'],
          },
          // SaaS to Core
          {
            to: '/core/configuration/server',
            from: ['/configuration/server'],
          },
          {
            to: '/core/configuration/provisioning',
            from: ['/configuration/provisioning'],
          },
          {
            to: '/core/configuration/analytics',
            from: ['/configuration/analytics'],
          },
          {
            to: '/core/configuration/telemetry',
            from: ['/configuration/telemetry'],
          },
          {
            to: '/core/configuration/upgrade',
            from: ['/configuration/upgrade'],
          },
          // Live Examples
          {
            to: '/live-examples/pokeshop/use-cases/add-pokemon',
            from: ['/pokeshop/add-pokemon/'],
          },
          {
            to: '/live-examples/pokeshop/use-cases/import-pokemon',
            from: ['/pokeshop/import-pokemon/'],
          },
          {
            to: '/live-examples/pokeshop/overview',
            from: ['/pokeshop'],
          },
        ],
        // createRedirects(existingPath) {
        //   if (existingPath.includes('/community')) {
        //     // Redirect from /docs/team/X to /community/X and /docs/support/X to /community/X
        //     return [
        //       existingPath.replace('/community', '/docs/team'),
        //       existingPath.replace('/community', '/docs/support'),
        //     ];
        //   }
        //   return undefined; // Return a falsy value: no redirect created
        // },
      },
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      docs: {
        sidebar: {
          hideable: true,
          autoCollapseCategories: true,
        },
      },  
      colorMode: {
        defaultMode: 'light',
        disableSwitch: false,
        respectPrefersColorScheme: false,
      },
      // Use this to add an announcement for a webinar or event.
      announcementBar: {
        id: 'announcement',
        // content:
        //   '<a target="_blank" rel="noopener noreferrer" href="https://www.youtube.com/live/2MSDy3XHjtE?si=VlK7cxJOsgKi5QTE&t=1132">Tracetest is the official testing harness for the OpenTelemetry Demo! 🚀</a>',
        content:
          '<a target="_blank" rel="noopener noreferrer" href="https://tracetest.io/blog/opentelemetry-is-not-just-for-monitoring-and-troubleshooting-any-longer-announcing-tracetest-open-beta">Tracetest Open Beta is Live. Try it! Give us feedback! 🙌</a>',
        isCloseable: false,
      },  
      navbar: {
        hideOnScroll: true,
        logo: {
          alt: 'Tracetest Logo',
          src: 'img/logo-landscape.svg',
          srcDark: 'img/logo-landscape-dark.svg',
          href: 'https://tracetest.io/',
          target: '_blank',
        },
        items: [
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'tutorialSidebar',
            label: 'Docs'
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'coreSidebar',
            label: 'Core'
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'examplesTutorialsSidebar',
            label: 'Examples & Tutorials'
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'liveExamplesSidebar',
            label: 'Live Examples'
          },
          {
            type: 'dropdown',
            label: 'Support',
            position: 'left',
            items: [
              {
                label: 'Overview',
                href: 'https://tracetest.io/support',
              },
              {
                label: 'Community',
                href: 'https://tracetest.io/community',
              },
              {
                label: 'Pricing',
                href: 'https://tracetest.io/pricing',
              },
              {
                label: 'Talk to us in Discord',
                href: 'https://discord.gg/6zupCZFQbe',
              },
              {
                label: 'Open an issue in GitHub',
                href: 'https://github.com/kubeshop/tracetest/issues/new/choose',
              },
              {
                label: 'Learn',
                href: 'https://tracetest.io/learn',
              },
              {
                label: 'Contact Us',
                href: 'https://tracetest.io/contact',
              },
            ],
          },
          {
            type: "html",
            position: "left",
            value: `<iframe src="https://ghbtns.com/github-btn.html?user=kubeshop&repo=tracetest&type=star&count=true&size=medium" style='margin-top: 6px' frameborder="0" scrolling="0" width="90" height="20" title="GitHub"></iframe>`,
          },
          {
            type: "search",
            position: "right",
          },
          {
            href: "https://app.tracetest.io",
            label: "Sign In",
            position: "right",
            className: "sign-in-button",
          },
        ],
      },
      footer: {
        style: "light",
        links: [
          {
            title: "Developers",
            items: [
              {
                label: "Docs",
                to: "/",
              },
            ],
          },
          {
            title: "Community",
            items: [
              {
                label: "Discord",
                href: "https://discord.gg/6zupCZFQbe",
              },
              {
                label: "Twitter",
                href: "https://twitter.com/tracetest_io",
              },
              {
                label: "LinkedIn",
                href: "https://www.linkedin.com/company/87135575",
              },
            ],
          },
          {
            title: "More",
            items: [
              {
                label: "Home",
                to: "https://tracetest.io",
              },
              {
                label: "Blog",
                to: "https://tracetest.io/blog",
              },
              {
                label: "GitHub",
                href: "https://github.com/kubeshop/tracetest",
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Kubeshop, Inc.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
      algolia: {
        // The application ID provided by Algolia
        appId: "L2ILN3GLIL",

        // Public API key: it is safe to commit it
        apiKey: "663c91299e298ff34c5a7a18f4451d1a",

        indexName: "tracetest",

        contextualSearch: false,

        searchPagePath: false,
      },
    }),
};

module.exports = config;