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');

// TODO remove the redirects from the old pages, we should update all GH repositories to link to new docs.
// This ensures URLs to our old Antora-based docs are successfully redirected to Docusaurus-based URLs
let oldVersions = ["latest", "0.21.0", "0.20.1", "0.20.0", "0.19.0", "0.18.0", "0.17.0", "0.16.0", "0.15.0", "0.14.0", "0.13.2", "0.13.1", "0.13.0", "0.12.0", "0.11.0", "0.10.0", "0.9.0", "0.8.0", "0.7.0", "0.6.0", "0.5.1", "0.5.0", "0.4.1", "0.3.1"]
let oldOverviewPages = ["pii", "organization", "hla"];
let replacements = [];

for (let oldVersion of oldVersions) {
  for (let oldOverviewPage of oldOverviewPages) {
    replacements.push({
      from: `/docs/${oldVersion}/${oldOverviewPage}.html`,
      to: `/docs/latest/overview/${oldOverviewPage}`,
    });
  }

  replacements.push({
    from: `/docs/${oldVersion}/about.html`,
    to: `/docs/latest/overview/`,
  });

  replacements.push({
    from: `/docs/${oldVersion}/definitions.html`,
    to: `/docs/latest/concepts/definitions`,
  });

  replacements.push({
    from: `/docs/${oldVersion}/concepts/schemas-and-contracts.html`,
    to: `/docs/latest/concepts/data-contracts/`,
  });
}

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'STRM Privacy Documentation',
  url: 'https://docs.strmprivacy.io/',
  baseUrl: '/',
  projectName: 'docs',
  organizationName: 'strmprivacy',
  baseUrlIssueBanner: false,
  trailingSlash: true,
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'throw',
  favicon: 'img/favicon.svg',

  scripts: [
    {
      src: 'https://plausible.io/js/plausible.js',
      defer: true,
      'data-domain': 'docs.strmprivacy.io'
    }
  ],
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          routeBasePath: '/docs',
          lastVersion: 'current',
          versions: {
            current: {
              label: 'latest',
              path: 'latest',
            },
          },
        },
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        sitemap: {
          changefreq: 'daily',
          priority: 0.5,
        }
      },
    ],
  ],

  themeConfig:
    ({
      navbar: {
        logo: {
          alt: 'STRM Privacy Logo',
          src: 'https://storage.googleapis.com/strm-media/strm-logo-orange-slim.svg',
          href: '/',
          target: '_self',
        },
        items: [
          {
            type: 'doc',
            position: 'left',
            docId: 'overview/index',
            label: 'Docs',
          },
          {
            label: 'Hiring!',
            position: 'left',
            to: 'https://join.strm.team/',
          },
          {
            href: 'https://github.com/strmprivacy',
            position: 'right',
            className: 'header-github-link',
            'aria-label': 'GitHub repository',
          }
        ],
      },
      footer: {
        style: 'dark',
        copyright: `Copyright (C) 2020-${(new Date().getFullYear())} STRM Privacy`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
        additionalLanguages: ['typescript', 'java', 'php', 'rust'],
        magicComments: [
          {className: 'callout callout-1', line: 'callout-1',},
          {className: 'callout callout-2', line: 'callout-2',},
          {className: 'callout callout-3', line: 'callout-3',},
          {className: 'callout callout-4', line: 'callout-4',},
          {className: 'callout callout-5', line: 'callout-5',},
          {className: 'callout callout-6', line: 'callout-6',},
          {className: 'callout callout-7', line: 'callout-7',},
          {className: 'callout callout-8', line: 'callout-8',},
          {className: 'callout callout-9', line: 'callout-9',},
          {className: 'callout callout-10', line: 'callout-10',},
          {className: 'callout callout-11', line: 'callout-11',},
          {className: 'callout callout-12', line: 'callout-12',},
          {className: 'callout callout-13', line: 'callout-13',},
          {className: 'callout callout-14', line: 'callout-14',},
          {className: 'callout callout-15', line: 'callout-15',},
          {className: 'callout callout-16', line: 'callout-16',},
          {className: 'callout callout-17', line: 'callout-17',},
          {className: 'callout callout-18', line: 'callout-18',},
          {className: 'callout callout-19', line: 'callout-19',},
          {className: 'callout callout-20', line: 'callout-20',},
        ]
      },
      algolia: {
        appId: 'M24OHV52F0',
        apiKey: '75af5c8e621e102165a0787ee4581b54',
        indexName: 'docusaurus-2',
      },
    }),
  plugins: [
    [
      '@docusaurus/plugin-client-redirects',
      {
        fromExtensions: ['html', 'htm'], // /myPage.html -> /myPage
        redirects: [
          ...replacements,
          {
            from: '/docs/latest',
            to: '/docs/latest/overview'
          }
        ]
      },
    ],
  ],
};

module.exports = config;