stoatchat/docs/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 type { ScalarOptions } from '@scalar/docusaurus';

const config: Config = {
  title: 'Stoat Developers',
  tagline: 'Developer documentation for Stoat',
  favicon: 'https://stoat.chat/favicon-stoat.svg',

  future: {
    v4: true,
  },

  url: 'https://developers.stoat.chat',
  baseUrl: '/',

  organizationName: 'stoatchat',
  projectName: 'stoatchat',

  onBrokenLinks: 'throw',

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

  presets: [
    [
      'classic',
      {
        docs: {
          routeBasePath: '/',
          sidebarPath: './sidebars.ts',
          editUrl:
            'https://github.com/stoatchat/stoatchat/tree/main/docs/',
        },
      } satisfies Preset.Options,
    ],
  ],

  plugins: [
    [
      '@scalar/docusaurus',
      {
        label: 'API Reference',
        route: '/api-reference',
        showNavLink: true,
        configuration: {
          url: 'https://stoat.chat/api/openapi.json',
        },
      } as ScalarOptions,
    ],
    [
      '@docusaurus/plugin-client-redirects',
      {
        fromExtensions: ['html', 'htm'],
        redirects: [
          // legacy docs website (stoatchat/developer-wiki)
          {
            from: '/developers/api/reference.html',
            to: '/api-reference',
          },
          {
            from: '/contrib.html',
            to: '/developing/contrib',
          },
          {
            from: '/contrib',
            to: '/developing/contrib',
          },
        ],
      }
    ],
  ],

  themeConfig: {
    // image: 'img/docusaurus-social-card.jpg',
    colorMode: {
      respectPrefersColorScheme: true,
    },
    navbar: {
      logo: {
        alt: 'Stoat for Developers',
        src: '/img/navbar.light.svg',
        srcDark: '/img/navbar.dark.svg'
      },
      items: [
        {
          type: 'doc',
          docId: 'index',
          label: 'Docs'
        },
        {
          href: 'https://github.com/stoatchat',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Developers',
          items: [
            {
              label: 'Source Code',
              href: 'https://github.com/stoatchat'
            },
            {
              label: 'Help Translate',
              href: 'https://translate.stoat.chat'
            },
          ],
        },
        {
          title: 'Team',
          items: [
            {
              label: 'About',
              href: 'https://stoat.chat/about'
            },
            {
              label: 'Blog and Changelogs',
              href: 'https://stoat.chat/updates'
            },
            {
              label: 'Contact',
              href: 'https://support.stoat.chat'
            },
          ],
        },
        {
          title: 'Stoat on Socials',
          items: [
            {
              label: 'Bluesky',
              href: 'https://bsky.app/profile/stoat.chat'
            },
            {
              label: 'Reddit',
              href: 'https://reddit.com/r/stoatchat'
            },
            {
              label: 'Stoat Server',
              href: 'https://stt.gg/Testers'
            },
          ],
        },
        {
          title: 'Legal',
          items: [
            {
              label: 'Community Guidelines',
              href: 'https://stoat.chat/legal/community-guidelines'
            },
            {
              label: 'Terms of Service',
              href: 'https://stoat.chat/legal/terms'
            },
            {
              label: 'Privacy Policy',
              href: 'https://stoat.chat/legal/privacy'
            },
            {
              label: 'Imprint',
              href: 'https://stoat.chat/legal/imprint'
            },
          ],
        },
      ],
      copyright: `© Revolt Platforms Ltd, ${new Date().getFullYear()}`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;