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

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

const config: Config = {
  title: 'ImapFlow',
  tagline: 'Modern and easy-to-use IMAP client library for Node.js',
  favicon: 'img/favicon.ico',

  // Enable Mermaid diagrams
  markdown: {
    mermaid: true,
  },
  themes: ['@docusaurus/theme-mermaid'],

  // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
  future: {
    v4: true, // Improve compatibility with the upcoming Docusaurus v4
  },

  // Set the production url of your site here
  url: 'https://imapflow.com',
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: '/',

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'postalsys', // Usually your GitHub org/user name.
  projectName: 'imapflow', // Usually your repo name.

  onBrokenLinks: 'throw',

  // Plausible analytics, loaded from emailengine.app rather than direct.
  //
  // EasyPrivacy, which uBlock Origin and AdGuard both enable by default, carries
  // ://plausible.*/js/script. and ://plausible.*/api/event|. Both match on the
  // hostname prefix, so the direct plausible.emailengine.dev URLs load for nobody
  // running a blocker. emailengine.app proxies both paths first-party (Caddy
  // handle blocks in its vhost on srv-04, see ../emailengine-web/CLAUDE.md).
  //
  // Unlike the other sites on that proxy, this one is a different registrable
  // domain, so these are third-party requests: anyone blocking third-party
  // scripts wholesale still loses analytics here. Serving it from an
  // imapflow.com subdomain would avoid that, but this site is GitHub Pages and
  // has no hostname on srv-04 to proxy from. Chosen deliberately over adding one.
  //
  // data-api must be absolute. A relative path would resolve against
  // imapflow.com, which is GitHub Pages and has no such route.
  scripts: [
    {
      src: 'https://emailengine.app/a/pv.js',
      defer: true,
      'data-domain': 'imapflow.com',
      'data-api': 'https://emailengine.app/a/e',
    },
  ],

  // Even if you don't use internationalization, you can use this field to set
  // useful metadata like html lang. For example, if your site is Chinese, you
  // may want to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl:
            'https://github.com/postalsys/imapflow/tree/master/docs/',
        },
        blog: false, // Disable blog for this documentation site
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    // Social card for sharing
    image: 'img/imapflow-social-card.svg',
    colorMode: {
      respectPrefersColorScheme: true,
    },
    algolia: {
      appId: 'P0H02EB2AJ',
      apiKey: 'f482204f0e3ef705441e4382bb225275',
      indexName: 'ImapFlow Documentation',

      // Optional: see doc section below
      contextualSearch: true,

      // Optional: path for search page that enabled by default (`false` to disable it)
      searchPagePath: "search",

      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
      insights: true,
    },
    navbar: {
      title: 'ImapFlow',
      logo: {
        alt: 'ImapFlow Logo',
        src: 'img/waving.png',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'tutorialSidebar',
          position: 'left',
          label: 'Documentation',
        },
        {
          href: 'https://github.com/postalsys/imapflow',
          label: 'GitHub',
          position: 'right',
        },
        {
          href: 'https://www.npmjs.com/package/imapflow',
          label: 'npm',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Getting Started',
              to: '/docs/',
            },
            {
              label: 'API Reference',
              to: '/docs/api/imapflow-client',
            },
          ],
        },
        {
          title: 'Community',
          items: [
            {
              label: 'GitHub Issues',
              href: 'https://github.com/postalsys/imapflow/issues',
            },
            {
              label: 'npm',
              href: 'https://www.npmjs.com/package/imapflow',
            },
          ],
        },
        {
          title: 'More',
          items: [
            {
              label: 'GitHub',
              href: 'https://github.com/postalsys/imapflow',
            },
            {
              label: 'EmailEngine',
              href: 'https://emailengine.app/',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Postal Systems OÜ. Licensed under MIT.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;