docusaurus.config.ts

import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import versionsData from './snapshots.json';

const docsVersion = process.env.DOCS_VERSION;
const algoliaAppId = process.env.ALGOLIA_APP_ID;
const algoliaApiKey = process.env.ALGOLIA_API_KEY;

const activeVersions = versionsData.snapshots
  .filter((v) => v.active)
  .map((v) => ({
    href: `pathname:///${v.version}/`,
    label: v.version,
    target: '_self' as const,
  }));

const config: Config = {
  title: 'Bactopia',
  tagline: 'An extensive workflow to process Nanopore and Illumina sequencing for bacterial genomes.',
  favicon: 'img/favicon.ico',

  url: 'https://bactopia.io',
  baseUrl: docsVersion ? `/${docsVersion}/` : '/',

  organizationName: 'bactopia',
  projectName: 'bactopia.github.io',
  deploymentBranch: 'gh-pages',
  trailingSlash: false,

  onBrokenLinks: 'warn',

  headTags: [
    {
      tagName: 'link',
      attributes: {
        rel: 'alternate',
        type: 'text/plain',
        href: '/llms.txt',
        title: 'LLM-readable site index',
      },
    },
    {
      tagName: 'link',
      attributes: {
        rel: 'alternate',
        type: 'application/json',
        href: '/catalog.json',
        title: 'Machine-readable documentation catalog',
      },
    },
  ],

  future: {
    v4: true,
  },

  markdown: {
    format: 'detect',

    parseFrontMatter: async (params) => {
      const result = await params.defaultParseFrontMatter(params);
      if (result.frontMatter.tags === null || result.frontMatter.tags === undefined) {
        delete result.frontMatter.tags;
      }
      return result;
    },
  },

  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  clientModules: ['./src/gtag-noop.js'],

  plugins: [
    [
      'docusaurus-plugin-cookie-consent',
      {
        title: 'Cookie Consent',
        description: 'This site uses cookies for analytics to help us understand how the documentation is used, including geographic visitor data.',
        links: [
          { label: 'Google Privacy Policy', href: 'https://policies.google.com/privacy' },
        ],
        categories: {
          necessary: { label: 'Necessary', enabled: false },
          analytics: { label: 'Analytics', description: 'Help us understand how visitors use the site.', enabled: false },
          marketing: { label: 'Marketing', enabled: false },
          functional: { label: 'Functional', enabled: false },
        },
        googleConsentMode: {
          enabled: true,
        },
      },
    ],
    'docusaurus-plugin-image-zoom',
    './src/plugins/social-cards.ts',
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'impact',
        path: 'impact',
        routeBasePath: 'impact-and-outreach',
        sidebarPath: './sidebars-impact.ts',
        editUrl: 'https://github.com/bactopia/bactopia.github.io/edit/master/',
      },
    ],
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'bactopia-tools',
        path: 'bactopia-tools',
        routeBasePath: 'bactopia-tools',
        sidebarPath: './sidebars-bactopia-tools.ts',
        editUrl: 'https://github.com/bactopia/bactopia.github.io/edit/master/',
      },
    ],
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'bactopia-pipelines',
        path: 'bactopia-pipelines',
        routeBasePath: 'bactopia-pipelines',
        sidebarPath: './sidebars-bactopia-pipelines.ts',
        editUrl: 'https://github.com/bactopia/bactopia.github.io/edit/master/',
      },
    ],
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'developers',
        path: 'developers',
        routeBasePath: 'developers',
        sidebarPath: './sidebars-developers.ts',
        editUrl: 'https://github.com/bactopia/bactopia.github.io/edit/master/',
        async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}: any) {
          const items = await defaultSidebarItemsGenerator(args);
          return items.filter((item: any) => !(item.type === 'doc' && item.id?.endsWith('/index')));
        },
      },
    ],
  ],

  presets: [
    [
      'classic',
      {
        docs: {
          routeBasePath: '/',
          sidebarPath: './sidebars.ts',
          editUrl: 'https://github.com/bactopia/bactopia.github.io/edit/master/',
          exclude: [
            'custom/**',
            'assets/**',
            'blog/**',
            'data/**',
            'impact-and-outreach/**',
          ],
          lastVersion: 'current',
          versions: {
            current: {
              label: 'v4.1.0',
              path: '',
              badge: false,
            },
          },
        },
        blog: {
          showReadingTime: true,
          editUrl: 'https://github.com/bactopia/bactopia.github.io/edit/master/',
          blogTitle: 'Bactopia Blog',
          blogDescription: 'News, tutorials, and updates from the Bactopia project.',
          blogSidebarCount: 'ALL',
          feedOptions: {
            type: ['rss', 'atom'],
            title: 'Bactopia Blog',
            description: 'News, tutorials, and updates from the Bactopia project.',
            copyright: `Copyright ${new Date().getFullYear()} Robert A. Petit III`,
          },
        },
        theme: {
          customCss: './src/css/custom.css',
        },
        ...(process.env.NODE_ENV === 'production' && {
          gtag: {
            trackingID: 'G-QH76FN9N78',
            anonymizeIP: true,
          },
        }),
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    ...(docsVersion && {
      announcementBar: {
        id: 'version_banner',
        content: `You are viewing docs for <strong>${docsVersion}</strong>. <a href="https://bactopia.io">View the latest version</a>.`,
        backgroundColor: '#d32f2f',
        textColor: '#fff',
        isCloseable: false,
      },
    }),
    image: 'img/bactopia-logo.png',
    navbar: {
      style: 'primary',
      title: '',
      logo: {
        alt: 'Bactopia Logo',
        src: 'img/bactopia-small-logo.png',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'bactopia',
          position: 'left',
          label: 'Bactopia',
        },
        {
          type: 'docSidebar',
          sidebarId: 'bactopia-tools',
          docsPluginId: 'bactopia-tools',
          position: 'left',
          label: 'Bactopia Tools',
        },
        {
          type: 'docSidebar',
          sidebarId: 'bactopia-pipelines',
          docsPluginId: 'bactopia-pipelines',
          position: 'left',
          label: 'Bactopia Pipelines',
        },
        {
          type: 'docSidebar',
          sidebarId: 'developers',
          docsPluginId: 'developers',
          position: 'left',
          label: 'Developers',
        },
        {
          type: 'docSidebar',
          sidebarId: 'impact',
          docsPluginId: 'impact',
          position: 'left',
          label: 'Impact & Outreach',
        },
        {to: '/blog', label: 'Blog', position: 'left'},
        {
          type: 'docsVersionDropdown',
          position: 'right',
          dropdownItemsAfter: [
            {type: 'html', value: '<hr style="margin: 0.3rem 0">'},
            ...activeVersions,
            {type: 'html', value: '<hr style="margin: 0.3rem 0">'},
            {
              href: 'https://github.com/bactopia/bactopia.github.io/branches/all?query=snapshot%2F',
              label: 'Archived Versions',
              target: '_blank',
            },
          ],
        },
        {
          type: 'search',
          position: 'right',
        },
        {
          type: 'custom-slack',
          position: 'right',
        },
        {
          type: 'custom-github',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Bactopia',
          items: [
            {
              label: 'Quick Start',
              to: '/quick-start',
            },
            {
              label: 'Installation',
              to: '/installation',
            },
            {
              label: 'CLI Reference',
              to: '/developers/cli/',
            },
          ],
        },
        {
          title: 'More Resources',
          items: [
            {
              label: 'Bactopia Tools',
              to: '/bactopia-tools/',
            },
            {
              label: 'Bactopia Pipelines',
              to: '/bactopia-pipelines/',
            },
            {
              label: 'Developers',
              to: '/developers/',
            },
          ],
        },
        {
          title: 'Community',
          items: [
            {
              label: 'GitHub',
              href: 'https://github.com/bactopia/bactopia',
            },
            {
              label: 'Bluesky',
              href: 'https://bsky.app/profile/bactopia.io',
            },
            {
              label: 'Slack',
              href: 'pathname:///slack/',
            },
          ],
        },
      ],
      copyright: `Copyright \u00A9 2019-${new Date().getFullYear()} Robert A. Petit III. All rights reserved.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['bash', 'json', 'yaml'],
    },
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    zoom: {
      selector: '.markdown :not(em) > img',
      background: {
        light: 'rgba(255, 255, 255, 0.9)',
        dark: 'rgba(50, 50, 50, 0.9)',
      },
    },
    ...(algoliaAppId && algoliaApiKey && {
      algolia: {
        appId: algoliaAppId,
        apiKey: algoliaApiKey,
        indexName: 'Bactopia Docs',
        contextualSearch: true,
        searchPagePath: 'search',
        askAi: "Bacto-Bot",
      },
    }),
  } satisfies Preset.ThemeConfig,
};

export default config;