docusaurus.config.js

// @ts-check

import { themes } from 'prism-react-renderer';

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Pester',
  tagline: 'The ubiquitous test and mock framework for PowerShell',
  url: 'https://pester.dev',
  baseUrl: '/',
  baseUrlIssueBanner: true,
  favicon: 'img/favicon.ico',
  organizationName: 'pester', // Usually your GitHub org/user name.
  projectName: 'docs', // Usually your repo name.
  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        {
          name: 'theme-color',
          content: '#0072c6'
        },
        // Use viewport-fit=cover to stretch website into safe-area (camera notch, swipe-for-menu etc.) on mobile.
        // Combine with padding in CSS to avoid conflicts using env(safe-area-inset-*) variables
        {
          name: 'viewport',
          content: 'width=device-width, initial-scale=1.0, viewport-fit=cover'
        }
      ],
      navbar: {
        title: 'Pester',
        logo: {
          alt: 'Pester Logo',
          src: 'img/logo_white.svg',
        },
        items: [
          {
            type: 'docsVersionDropdown',
            position: 'left',
          },
          {
            type: 'doc',
            label: 'Docs',
            docId: 'quick-start',
            position: 'right'
          },
          {
            type: 'doc',
            label: 'Commands',
            docId: 'commands/Add-ShouldOperator',
            position: 'right'
          },
          {
            label: 'GitHub',
            href: 'https://github.com/pester/pester',
            position: 'right',
          },
          {
            type: 'search', // algolia search
            position: 'right',
          },
        ],
      },
      prism: {
        theme: themes.github,
        darkTheme: themes.oceanicNext,
        additionalLanguages: [
          'bash',
          'powershell',
          'yaml'
        ]
      },
      // Please note that the Algolia DocSearch crawler only runs once every 24 hours.
      // Configuration options below described at https://docusaurus.io/docs/search.
      algolia: {
        appId: 'Q2JBAARHQ6',
        apiKey: '59daca417dcd80d5cc18fac56af5c138',
        indexName: 'pester',
        contextualSearch: true,
        // searchParameters: {},
        //... other Algolia params
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Documentation',
            items: [
              {
                label: 'Quick Start',
                to: 'docs/quick-start',
              },
              {
                label: 'Installation',
                to: 'docs/introduction/installation',
              },
              {
                label: 'Command Reference',
                to: 'docs/commands/Add-ShouldOperator',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Gitter',
                href: 'https://gitter.im/pester/Pester',
              },
              {
                label: 'PowerShell.org',
                href: 'https://forums.powershell.org/c/pester/',
              },
              {
                label: 'Slack',
                href: 'https://powershell.slack.com/messages/C03QKTUCS',
              },
              {
                label: 'Discord (#testing)',
                href: 'https://discord.gg/powershell',
              },
              {
                label: 'Stack Overflow',
                href: 'https://stackoverflow.com/questions/tagged/pester',
              },
              {
                label: 'Twitter',
                href: 'https://twitter.com/PSPester',
              },
            ],
          },
          {
            title: 'Sponsoring',
            items: [
              {
                label: 'GitHub',
                href: 'https://github.com/sponsors/nohwnd',
              },
              {
                label: 'Open Collective',
                href: 'https://opencollective.com/pester/donate',
              },
            ],
          },
        ],
        copyright: `Copyright Pester Team © 2019-present`,
      },
    }),
  presets: [
    [
      '@docusaurus/preset-classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: './sidebars.js',
          editUrl: 'https://github.com/pester/docs/edit/main',
          // Define which version ("current" vs versioned docs like "v5") that will use unversioned URIs /docs/...
          // Using v5 while it's latest stable.
          // When updated, also update static/_redirects to always support versioned URIs
          lastVersion: "v5",
          includeCurrentVersion: true,
          disableVersioning: false,
          versions: {
            // "current" is content in /docs folder
            current: {
              label: "v6 (preview) 🚧",
              // path is /docs/next by default unless lastVersion is set to "current"
              // overriden to /docs/v6 during preview
              path: "v6"
            }
          },
        },
        theme: {
          customCss: './src/css/custom.css',
        },
      }),
    ],
  ],
};

export default config;