docusaurus.config.ts

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

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

const config: Config = {
  title: 'Cryptomator Documentation',
  tagline: 'Protect your privacy in any cloud',
  favicon: 'img/favicon.ico',

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

  url: process.env.SITE_URL || 'https://docs.cryptomator.org',
  baseUrl: '/',

  // GitHub pages deployment config.
  organizationName: 'cryptomator',
  projectName: 'docs',
  trailingSlash: true,

  onBrokenLinks: 'throw',

  markdown: {
    hooks: {
      onBrokenMarkdownLinks: 'warn',
    },
  },

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

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl:
            'https://github.com/cryptomator/docs/tree/develop/',
          routeBasePath: '/',
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],

  clientModules: [
    require.resolve('./src/clientModules/utmRemover.ts'),
  ],

  headTags: [
    {
      tagName: 'script',
      attributes: {
        src: 'https://umami.skymatic.de/script.js',
        'data-website-id': process.env.NODE_ENV === 'development' || process.env.SITE_URL
          ? 'cdd42f46-583d-4463-9ab2-8adcfe989c21' // Local development / Staging
          : '2df416f9-7a9c-4e58-9a45-7106f7e0a139', // Production
        integrity: 'sha384-ZMxgpYfO/phGz4GiYTIZhcauuGKTb2onmOB5gsiigjmBR38DGAmIna5J1Y/dM/13',
        crossorigin: 'anonymous',
        defer: 'defer',
      },
    },
    {
      tagName: 'script',
      attributes: {
        src: 'https://umami.skymatic.de/recorder.js',
        'data-website-id': process.env.NODE_ENV === 'development' || process.env.SITE_URL
          ? 'cdd42f46-583d-4463-9ab2-8adcfe989c21' // Local development / Staging
          : '2df416f9-7a9c-4e58-9a45-7106f7e0a139', // Production
        integrity: 'sha384-RFbJB7wXp6wvtb7Yj7euqgFcWmpCYnwbQM8RHA4TiyV8qukjCB/YV9blThgO/M5Z',
        crossorigin: 'anonymous',
        defer: 'defer',
      },
    },
  ],

  plugins: [
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          // Hub 2.0 restructure: reference pages moved into the three guides (User/Admin/Self-Hosting)
          { from: '/hub/your-account', to: '/hub/user-guide/your-account' },
          { from: '/hub/vault-management', to: '/hub/user-guide/vault-management' },
          { from: '/hub/access-vault', to: '/hub/user-guide/access-vault' },
          { from: '/hub/vault-recovery', to: '/hub/user-guide/vault-recovery' },
          { from: '/hub/user-group-management', to: '/hub/admin-guide/user-group-management' },
          { from: '/hub/keycloak', to: '/hub/admin-guide/keycloak' },
          { from: '/hub/emergency-access', to: '/hub/admin-guide/emergency-access' },
          // /hub/admin was split into License / Audit Logs / Web of Trust / Emergency Access;
          // a page redirect can't carry the old #anchors, so it lands on the Admin Guide entry point.
          { from: '/hub/admin', to: '/hub/admin-guide' },
          { from: '/hub/quick-start', to: '/hub/self-hosting-guide/quick-start' },
          { from: '/hub/operations', to: '/hub/self-hosting-guide/operations' },
          { from: '/hub/deployment', to: '/hub/self-hosting-guide/deployment' },
          { from: '/hub/deployment/compose', to: '/hub/self-hosting-guide/deployment/compose' },
          { from: '/hub/deployment/kubernetes', to: '/hub/self-hosting-guide/deployment/kubernetes' },
          { from: '/hub/deployment/rancher', to: '/hub/self-hosting-guide/deployment/rancher' },
          {
            from: '/hub/setup/requirements',
            to: '/hub/self-hosting-guide/deployment/#hardware-requirements',
          },
          {
            from: '/hub/setup/billing',
            to: '/hub/admin-guide/license',
          },
          {
            from: '/hub/setup/keycloak-administration',
            to: '/hub/admin-guide/keycloak',
          },
          {
            from: '/hub/setup',
            to: '/hub/self-hosting-guide/deployment',
          },
          {
            from: '/hub/access-vault/unlocking-a-vault/4.-vault-unlocked',
            to: '/hub/user-guide/access-vault/#vault-unlocked',
          },
          {
            from: '/hub/access-vault/unlocking-a-vault/3.-add-device',
            to: '/hub/user-guide/access-vault/#register-device',
          },
          {
            from: '/hub/access-vault/unlocking-a-vault/2.-authenticate',
            to: '/hub/user-guide/access-vault/#authenticate',
          },
          {
            from: '/hub/access-vault/unlocking-a-vault/1.-click-unlock',
            to: '/hub/user-guide/access-vault/#click-unlock',
          },
          {
            from: '/hub/license',
            to: '/hub/admin-guide/license',
          },
          {
            from: '/desktop/vault-mounting',
            to: '/desktop/volume-type',
          },
          {
            from: '/help/manual-migration',
            to: '/misc/manual-migration',
          },
        ],
      },
    ],
    [
      '@signalwire/docusaurus-plugin-llms-txt',
      {
        content: {
          enableLlmsFullTxt: true,
          excludeRoutes: [
            '/',
            '/search/',
            '/android/',
            '/desktop/',
            '/ios/',
            '/hub/',
            '/misc/',
            '/security/',
          ],
        },
      },
    ],
  ],

  themes: [
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
      ({
        indexBlog: false,
        indexPages: false,
        docsRouteBasePath: "/",
        hashed: true,
      }),
    ],
  ],

  themeConfig: {
    image: 'img/og-image.png',
    navbar: {
      title: 'CRYPTOMATOR',
      logo: {
        alt: 'Cryptomator Logo',
        src: 'img/logo.svg',
      },
      items: [
        {
          label: 'Desktop',
          to: 'desktop/setup',
          activeBasePath: 'desktop/',
          position: 'left',
        },
        {
          label: 'Android',
          to: 'android/setup',
          activeBasePath: 'android/',
          position: 'left',
        },
        {
          label: 'iOS',
          to: 'ios/setup',
          activeBasePath: 'ios/',
          position: 'left',
        },
        {
          label: 'Hub',
          to: 'hub/introduction',
          activeBasePath: 'hub/',
          position: 'left',
        },
        {
          label: 'Security',
          to: 'security/security-target',
          activeBasePath: 'security/',
          position: 'left',
        },
        {
          label: 'Misc',
          to: 'misc/contribute',
          activeBasePath: 'misc/',
          position: 'left',
        },
        {
          href: 'https://github.com/cryptomator',
          position: 'right',
          className: 'header-github-link',
          'aria-label': 'GitHub',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Cryptomator',
          items: [
            {
              label: 'Website',
              href: 'https://cryptomator.org/',
            },
            {
              label: 'Community',
              href: 'https://community.cryptomator.org/',
            },
          ],
        },
        {
          title: 'Contribute',
          items: [
            {
              label: 'GitHub',
              href: 'https://github.com/cryptomator',
            },
            {
              label: 'Donate',
              href: 'https://cryptomator.org/donate/',
            },
            {
              label: 'Translate',
              href: 'https://translate.cryptomator.org/',
            },
          ],
        },
        {
          title: 'Follow Us',
          items: [
            {
              label: 'Blog',
              href: 'https://cryptomator.org/blog/',
            },
            {
              label: 'Mastodon',
              href: 'https://mastodon.online/@cryptomator',
            },
            {
              label: 'LinkedIn',
              href: 'https://linkedin.com/company/skymatic',
            },
          ],
        },
        {
          title: 'Legal',
          items: [
            {
              label: 'Impressum',
              href: 'https://cryptomator.org/impressum/',
            },
            {
              label: 'Privacy Policy',
              href: 'https://cryptomator.org/privacy/',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} cryptomator.org. Built with Docusaurus.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['bash', 'diff', 'ini'],
    },
  } satisfies Preset.ThemeConfig,
};

export default config;