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';
import { readdirSync } from 'node:fs';
import latestVersions from "./src/plugins/latest-versions";
import remarkTokenReplacer from "./src/plugins/replace-tokens";
import redirects from "./redirects";

// Fast iteration on the redesigned recipe pages: when EXAMPLE_RECIPES_ONLY is set, exclude the entire
// recipe-catalog EXCEPT the handful of example pages we're actively developing, so a build/start only
// compiles those (plus the rest of the non-catalog docs) instead of all ~5,700 catalog pages.
const RECIPE_CATALOG = 'user-documentation/recipes/recipe-catalog';
const EXAMPLE_RECIPE_PAGES = [
  `${RECIPE_CATALOG}/staticanalysis/replaceduplicatestringliterals.md`,
  `${RECIPE_CATALOG}/staticanalysis/commonstaticanalysis.md`,
  `${RECIPE_CATALOG}/quarkus/quarkus1to1_13migration.md`,
];

function exampleRecipesExclude(): string[] {
  const keep = new Set(EXAMPLE_RECIPE_PAGES);
  return readdirSync(`docs/${RECIPE_CATALOG}`, { recursive: true })
    .map((f) => `${RECIPE_CATALOG}/${String(f).replace(/\\/g, '/')}`)
    .filter((f) => /\.mdx?$/.test(f) && !keep.has(f));
}

const config: Config = {
  title: 'Moderne Docs',
  tagline: 'Large-scale automated source code refactoring',

  url: 'https://docs.moderne.io',
  baseUrl: '/',

  organizationName: 'moderneinc',
  projectName: 'moderne-docs',

  // Only throw on broken links when the full site (including recipe catalog) is built.
  onBrokenLinks: (process.env.CI_STRICT_LINKS && !process.env.SKIP_RECIPE_CATALOG && !process.env.EXAMPLE_RECIPES_ONLY) ? 'throw' : 'warn',

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

  scripts: [
    {
      src: 'reo.js',
    }
  ],

  clientModules: [
    require.resolve('./src/client/gtagGuard.js'),
    require.resolve('./src/client/algoliaInsights.js'),
  ],

  headTags: [
    // <link rel="preconnect" href="https://fonts.googleapis.com">
    {
      tagName: 'link',
      attributes: {
        rel: 'preconnect',
        href: 'https://fonts.googleapis.com',
      },
    },
    // <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
    {
      tagName: 'link',
      attributes: {
        rel: 'preconnect',
        href: 'https://fonts.gstatic.com',
        crossorigin: 'anonymous',
      },
    },
    {
      tagName: 'link',
      attributes: {
        rel: 'stylesheet',
        href: 'https://fonts.googleapis.com/css2?family=Geist:ital,wght@0,300..700;1,300..700&family=Geist+Mono:ital,wght@0,400;0,500;1,400&display=swap',
      },
    },
    {
      tagName: 'link',
      attributes: {
        rel: 'icon',
        href: '/img/favicon.ico',
        type: 'image/x-icon',
        sizes: '32x32',
        media: '(prefers-color-scheme: light)',
      },
    },
    {
      tagName: 'link',
      attributes: {
        rel: 'icon',
        href: '/img/favicon_dark.ico',
        type: 'image/x-icon',
        sizes: '32x32',
        media: '(prefers-color-scheme: dark)',
      },
    },
  ],

  presets: [
    [
      'classic',
      {
        docs: {
          routeBasePath: "/",
          sidebarCollapsible: true,
          sidebarPath: './sidebars.ts',
          editUrl:
            'https://github.com/moderneinc/moderne-docs/edit/main',
          // Disabled on Vercel to allow manual preview deployments via `npx vercel`
          // (CLI deployments don't include .git directory, breaking git-based timestamps)
          showLastUpdateTime: !process.env.VERCEL,
          // showLastUpdateAuthor: true,
          exclude: [
            '**/*.stories.tsx',
            '**/*.stories.ts',
            '**/*.stories.jsx',
            '**/*.stories.js',
            // Skip 5,700+ recipe-catalog pages for faster local rebuilds.
            // Use `yarn start:fast` to enable this; `yarn start` includes everything.
            ...(process.env.SKIP_RECIPE_CATALOG ? ['user-documentation/recipes/recipe-catalog/**'] : []),
            ...(process.env.EXAMPLE_RECIPES_ONLY ? exampleRecipesExclude() : []),
          ],
          remarkPlugins: [
            [
              remarkTokenReplacer,
              {
                replacements: latestVersions,
              },
            ],
          ],
          admonitions: {
            keywords: ['summary'],
            extendDefaults: true,
          },
        },
        gtag: {
          trackingID: "G-Q1CMC219Y5",
        },
        theme: {
          customCss: [
            './src/css/morpheus-tokens.css',
            './src/css/custom.css',
            './src/css/morpheus-theme.css',
          ],
        },
      } satisfies Preset.Options,
    ],
  ],

  markdown: {
    mermaid: true,
    hooks: {
      // Only throw on broken markdown links when the full site (including recipe catalog) is built.
      // When SKIP_RECIPE_CATALOG is set, recipe list pages will have expected broken links.
      onBrokenMarkdownLinks: (process.env.CI_STRICT_LINKS && !process.env.SKIP_RECIPE_CATALOG) ? 'throw' : 'warn',
      onBrokenMarkdownImages: process.env.CI_STRICT_LINKS ? 'throw' : 'warn',
    }
  },

  themes: [
    '@docusaurus/theme-mermaid',
  ],

  plugins: [
    // TRIAL (throwaway): site-wide copy/view-as-markdown button for LLMs.
    [
      'docusaurus-plugin-copy-page-button',
      {
        // We render the button ourselves (src/components/CopyPageAction via the DocBreadcrumbs /
        // DocItem-Layout swizzles) rather than the plugin's auto-injection, which is unreliable on
        // pages with hydration mismatches. Actions + markdownUrl are configured on the component.
        // No generateMarkdownRoutes: non-catalog pages reuse docusaurus-plugin-llms' /path.md, and
        // recipe pages point at their GitHub raw source.
        injectButton: false,
      },
    ],
    [
      'docusaurus-plugin-llms',
      {
        generateLLMsTxt: true,
        generateLLMsFullTxt: false,
        generateMarkdownFiles: true,
        docsDir: 'docs',
        title: 'Moderne Documentation',
        description: 'Large-scale automated source code refactoring',
        excludeImports: true,
        removeDuplicateHeadings: true,
        ignoreFiles: ['**/recipe-catalog/**'],
        customLLMFiles: [
          {
            filename: 'llms-platform.txt',
            includePatterns: ['**/moderne-platform/**/*'],
            fullContent: false,
            title: 'Moderne Platform Documentation',
            description: 'Enterprise SaaS solution for automated code remediation',
          },
          {
            filename: 'llms-cli.txt',
            includePatterns: ['**/moderne-cli/**/*'],
            fullContent: false,
            title: 'Moderne CLI Documentation',
            description: 'Command-line interface for running recipes locally',
          },
          {
            filename: 'llms-dx.txt',
            includePatterns: ['**/moderne-dx/**/*'],
            fullContent: false,
            title: 'Moderne DX Documentation',
            description: 'On-premise deployment solution',
          },
        ],
      },
    ],
    // Client-side redirects for docs that have moved. The list lives in
    // ./redirects.ts — add an entry there when you move or rename a doc.
    [
      '@docusaurus/plugin-client-redirects',
      { redirects },
    ],
  ],

  future: {
    faster: {
      // SSG worker threads parallelise per-page rendering; each worker
      // holds a React render tree and a copy of the server bundle,
      // multiplying sustained memory across pages in flight. With the
      // full recipe-catalog build (~7,500 routes) on ubuntu-latest's
      // 16 GB the kernel SIGTERMs the job mid-build. Locally we keep
      // parallel SSG for speed; on CI we serialise to keep sustained
      // memory bounded. Rspack/SWC keep their own internal parallelism
      // for the bundling/minimising work either way.
      ssgWorkerThreads: !process.env.CI,
      swcJsLoader: true,
      swcJsMinimizer: true,
      swcHtmlMinimizer: true,
      lightningCssMinimizer: true,
      rspackBundler: true,
      rspackPersistentCache: true,
      mdxCrossCompilerCache: true,
    },
    v4: true,
  },

  themeConfig: {
    algolia: {
      appId: "MEFFK0HGO6",
      apiKey: "15eb9c9f6f3147b1cf82b1b7f93cace8",
      indexName: "moderne",
      // Search filtering is handled by SearchFacetTabs (src/theme/SearchBar)
      insights: true,
      searchParameters: {
        clickAnalytics: true,
      },
    },
    announcementBar: {
      id: "code_genome_project",
      content: 'Recipes are moving from Maven Central to the <a href="https://codegenomeproject.org/" target="_blank" rel="noopener noreferrer">Code Genome Project</a>. <a href="/administrator-documentation/moderne-platform/how-to-guides/accessing-the-code-genome-project">Configure access</a> to keep releases resolving.',
      isCloseable: true,
    },
    colorMode: {
      respectPrefersColorScheme: true,
    },
    image: 'img/moderne-poster-logo.svg',
    navbar: {
      logo: {
        alt: 'Moderne Logo Logo',
        src: 'img/logo.svg',
        srcDark: 'img/darkLogo.svg',
      },
      // Navigation handled by MegaMenu in swizzled Navbar/Layout component
    },
    footer: {
      copyright: `© Moderne, ${new Date().getFullYear()}`,
    },
    prism: {
      theme: prismThemes.vsDark,
      darkTheme: prismThemes.vsDark,
      additionalLanguages: [
        "bash",
        "docker",
        "groovy",
        "java",
        "kotlin",
        "yaml",
        "powershell",
        "csv",
      ],
    },
    sidebar: {
      hideable: true,
    }
  } satisfies Preset.ThemeConfig,
};

export default config;