docusaurus.config.ts

import type * as Preset from '@docusaurus/preset-classic';
import type { Config } from '@docusaurus/types';
import { themes } from 'prism-react-renderer';
import redirects from './legacy-redirects';

const config: Config = {
  future: {
    experimental_faster: true,
  },
  title: 'Stryker Mutator',
  tagline: 'Test your tests with mutation testing.',
  url: 'https://stryker-mutator.io',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  favicon: '/images/stryker.svg',
  organizationName: 'stryker-mutator',
  projectName: 'stryker-mutator.github.io',
  trailingSlash: true,
  onBrokenAnchors: 'throw',
  themeConfig: {
    image: 'images/strykerman.png',
    colorMode: {
      respectPrefersColorScheme: true,
    },
    announcementBar: {
      id: 'talk', // Any value that will identify this message.
      content:
        '📣 Discover the <a target="_blank" href="https://fosdem.org/2024/schedule/event/fosdem-2024-1683-who-s-testing-the-tests-mutation-testing-with-strykerjs/">"Who\'s testing the tests? Mutation testing with StrykerJS"</a> talk on FOSDEM 2024.',
      backgroundColor: 'var(--ifm-navbar-background-color, #fff)',
      textColor: 'var(--ifm-navbar-link-color, #000)',
      isCloseable: true,
    },
    navbar: {
      title: 'Stryker Mutator',
      logo: {
        alt: 'Stryker Mutator Logo',
        src: 'images/stryker.svg',
        height: 32,
        width: 32,
      },
      items: [
        { to: 'blog', label: 'Blog', position: 'left' },
        {
          to: 'docs/stryker-js/introduction',
          activeBasePath: 'docs/stryker-js/',
          label: 'For JavaScript',
          position: 'left',
        },
        {
          to: 'docs/stryker-net/introduction',
          activeBasePath: 'docs/stryker-net',
          label: 'For C#',
          position: 'left',
        },
        {
          to: 'docs/stryker4s/getting-started',
          activeBasePath: 'docs/stryker4s',
          label: 'For Scala',
          position: 'left',
        },
        {
          to: 'docs/General/example',
          activeBasePath: 'docs/General/example',
          label: 'An example',
          position: 'left',
        },
        {
          href: 'https://stryker-mutator.io/stryker-playground/',
          label: 'Playground',
          position: 'left',
        },
        {
          href: 'https://dashboard.stryker-mutator.io',
          label: 'Dashboard',
          position: 'right',
        },
        {
          href: '#',
          target: '_self',
          position: 'right',
          className: 'header-github-link',
          'aria-label': 'GitHub repository dropdown',
          items: [
            {
              label: 'StrykerJS (JS & TS)',
              href: 'https://github.com/stryker-mutator/stryker-js',
            },
            {
              label: 'Stryker.NET (C#)',
              href: 'https://github.com/stryker-mutator/stryker-net',
            },
            {
              label: 'Stryker4s (Scala)',
              href: 'https://github.com/stryker-mutator/stryker4s',
            },
            {
              label: 'Mutation Testing Elements',
              href: 'https://github.com/stryker-mutator/mutation-testing-elements',
            },
            {
              label: 'Stryker Dashboard',
              href: 'https://github.com/stryker-mutator/stryker-dashboard',
            },
            {
              label: 'This website',
              href: 'https://github.com/stryker-mutator/stryker-mutator.github.io',
            },
          ],
        },
      ],
    },
    footer: {
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'FAQ',
              to: 'docs/General/faq',
            },
          ],
        },
        {
          title: 'Community',
          items: [
            {
              label: 'Slack',
              href: 'https://join.slack.com/t/stryker-mutator/shared_invite/enQtOTUyMTYyNTg1NDQ0LTU4ODNmZDlmN2I3MmEyMTVhYjZlYmJkOThlNTY3NTM1M2QxYmM5YTM3ODQxYmJjY2YyYzllM2RkMmM1NjNjZjM',
            },
            {
              label: 'Twitter',
              href: 'https://twitter.com/stryker_mutator',
            },
          ],
        },
        {
          title: 'More',
          items: [
            {
              label: 'Blog',
              to: 'blog',
            },
            {
              label: 'GitHub',
              href: 'https://github.com/stryker-mutator/',
            },
          ],
        },
      ],
      copyright: `Powered by <a target="_blank" rel="noopener noreferrer" href="https://www.infosupport.com/open-source/">Info Support</a>.<br/>Stryker is released under the Apache 2.0 license. Site by the <a target="_blank" rel="noopener noreferrer" href="https://github.com/orgs/stryker-mutator/people">Stryker team</a>. Logo by Selina van den Top.`,
      logo: {
        alt: 'Info Support Logo',
        src: 'images/info-support.svg',
        href: 'https://infosupport.com',
        width: 117,
        height: 33,
      },
    },
    prism: {
      additionalLanguages: ['java', 'scala', 'csharp', 'diff', 'json'],
      theme: themes.github,
      darkTheme: themes.dracula,
    },

    algolia: {
      appId: 'QF3A1J09N2',
      apiKey: 'b0ec9342a88037eafe5fa4fd412b8b35',
      indexName: 'stryker-mutator',
      contextualSearch: false,
    },
    metadata: [
      {
        name: 'keywords',
        content: 'mutation testing, JavaScript, TypeScript, C#, .NET, Scala, testing, testing tools, software',
      },
      { name: 'theme-color', content: '#e74c3c' },
    ],
  } satisfies Preset.ThemeConfig,
  headTags: [
    {
      tagName: 'link',
      attributes: { ref: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' },
    },
    {
      tagName: 'link',
      attributes: { rel: 'mask-icon', href: '/safari-pinned-tab.svg', color: '#e74c3c' },
    },
    {
      tagName: 'link',
      attributes: { rel: 'manifest', href: '/manifest.json' },
    },
  ],
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl: 'https://github.com/stryker-mutator/stryker-mutator.github.io/edit/develop/',
        },
        blog: {
          showReadingTime: true,
          editUrl: 'https://github.com/stryker-mutator/stryker-mutator.github.io/edit/develop/',
        },
        theme: {
          customCss: './src/css/custom.css',
        },
        gtag: {
          trackingID: 'G-JN49KF9BV1',
          // Optional fields.
          anonymizeIP: true, // Should IPs be anonymized?
        },
      } satisfies Preset.Options,
    ],
  ],
  plugins: [
    ['@docusaurus/plugin-client-redirects', { redirects }],
    [
      '@docusaurus/plugin-pwa',
      {
        debug: false,
        injectManifestConfig: {
          globPatterns: ['images/{stryker,stryker-man,stryker-gun,info-support}.svg'],
        },
      },
    ],
  ],
  markdown: {
    mermaid: true,
  },
  themes: ['@docusaurus/theme-mermaid'],
};

export default config;