docsearch/packages/website/docusaurus.config.js

/* eslint-disable @typescript-eslint/no-var-requires */
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const lightCodeTheme = require('prism-react-renderer/themes/github');

// With JSDoc @type annotations, IDEs can provide config autocompletion
/** @type {import('@docusaurus/types').DocusaurusConfig} */
(
  module.exports = {
    title: 'DocSearch by Algolia',
    tagline:
      'The best search experience for docs, integrated in minutes, for free.',
    url: 'https://docsearch.algolia.com',
    baseUrl: '/',
    favicon: 'img/favicon.ico',
    organizationName: 'Algolia',
    projectName: 'DocSearch',
    onBrokenLinks: 'throw',
    onBrokenMarkdownLinks: 'warn',
    presets: [
      [
        '@docusaurus/preset-classic',
        /** @type {import('@docusaurus/preset-classic').Options} */
        ({
          docs: {
            path: 'docs',
            sidebarPath: 'sidebars.js',
            editUrl:
              'https://github.com/algolia/docsearch/edit/next/packages/website/',
            versions: {
              current: {
                label: 'current',
              },
            },
            lastVersion: 'current',
            showLastUpdateAuthor: true,
            showLastUpdateTime: true,
          },
          theme: {
            customCss: require.resolve('./src/css/custom.css'),
          },
        }),
      ],
    ],
    plugins: ['my-loaders', 'tailwind-loader'],
    themeConfig:
      /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
      ({
        algolia: {
          appId: 'R2IYF7ETH7',
          apiKey: '599cec31baffa4868cae4e79f180729b',
          indexName: 'docsearch',
          contextualSearch: true,
        },
        navbar: {
          hideOnScroll: true,
          logo: {
            alt: 'DocSearch',
            src: 'img/docsearch-logo.svg',
            srcDark: 'img/docsearch-logo-white.svg',
          },
          items: [
            // left
            {
              label: 'Docs',
              to: 'docs/what-is-docsearch',
              position: 'left',
            },
            // right
            {
              type: 'docsVersionDropdown',
              position: 'right',
            },
            {
              href: 'https://github.com/algolia/docsearch',
              position: 'right',
              className: 'header-github-link',
            },
          ],
        },
        colorMode: {
          defaultMode: 'light',
          disableSwitch: false,
          respectPrefersColorScheme: true,
        },
        announcementBar: {
          content:
            '⭐️ If you like DocSearch, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/algolia/docsearch">GitHub</a>! ⭐️',
        },
        footer: {
          links: [
            {
              title: 'Docs',
              items: [
                {
                  label: 'Getting Started',
                  to: 'docs/what-is-docsearch',
                },
                {
                  label: 'FAQ',
                  to: 'docs/faq',
                },
                {
                  label: 'DocSearch v3',
                  to: 'docs/DocSearch-v3',
                },
              ],
            },
            {
              title: 'DocSearch',
              items: [
                {
                  label: 'Apply',
                  to: 'apply',
                },
                {
                  label: 'Issues',
                  to: 'https://github.com/algolia/docsearch/issues',
                },
                {
                  label: 'Privacy',
                  to: 'https://www.algolia.com/policies/privacy/',
                },
              ],
            },
            {
              title: 'Community',
              items: [
                {
                  label: 'Forum',
                  to: 'https://discourse.algolia.com/tags/docsearch',
                },
                {
                  label: 'Discord',
                  to: 'https://discord.com/invite/bRTacwYrfX',
                },
              ],
            },
            {
              title: 'Social',
              items: [
                {
                  label: 'GitHub',
                  to: 'https://github.com/algolia/docsearch',
                },
                {
                  label: 'Twitter',
                  to: 'https://twitter.com/docsearch_',
                },
                {
                  label: 'Algolia Blog',
                  to: 'https://algolia.com/blog/',
                },
              ],
            },
          ],
          logo: {
            alt: 'Algolia',
            src: 'img/algolia-logo.svg',
          },
          copyright: 'DocSearch 2015-now • Designed and built by Algolia',
        },
        image: 'img/og_image.png',
        prism: {
          theme: lightCodeTheme,
          darkTheme: darkCodeTheme,
        },
      }),
  }
);