docusaurus.config.js

// @ts-check
const { themes } = require('prism-react-renderer')
const lightCodeTheme = themes.github
const darkCodeTheme = themes.dracula

const u = require('./docusaurus.config.utils')

const versions = require('./versions.json')

const BASE_URL = process.env.BASE_URL ?? '/'

const isDev = process.env.NODE_ENV === 'development'
const latestMajorVersion = versions.find((v) => v.startsWith('v'))?.split('.')[0] || 'v5'

u.checkGeneratedData()

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Fastify',
  tagline: 'Fast and low overhead web framework, for Node.js',
  url: 'https://fastify.io',
  baseUrl: BASE_URL,
  onBrokenLinks: 'warn',
  favicon: 'img/favicon.ico',
  // GitHub Pages redirects with a trailing slash, so this configures links to match
  trailingSlash: true,

  // GitHub pages deployment config.
  organizationName: 'fastify',
  projectName: 'website',

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

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

  // https://docusaurus.io/docs/using-plugins#using-presets
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        debug: true, // force debug plugin usage

        // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#configuration
        docs: {
          lastVersion: 'latest', // the last version is always "latest"
          editUrl: (editPage) => {
            // Users can not submit doc updates to the legacy versions!
            if (editPage.version !== 'latest' && !editPage.version.startsWith(latestMajorVersion)) {
              return undefined
            }

            // We want users to submit doc updates to the upstream/next version!
            return `https://github.com/fastify/fastify/edit/main/docs/${editPage.docPath}`
          },
          editCurrentVersion: false,
          sidebarPath: 'sidebar.js',
          showLastUpdateTime: true,
          breadcrumbs: true,
          includeCurrentVersion: isDev,
          versions: u.getVersionLabels(versions),
          onlyIncludeVersions: u.getVersionsIncluded({ versions, fastBuild: isDev }),
          sidebarItemsGenerator: require('./sidebar.js'),
        },

        // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog#configuration
        blog: false,

        // https://docusaurus.io/docs/api/themes/@docusaurus/theme-classic
        theme: {
          customCss: [
            require.resolve('./src/css/custom.css'), //
            require.resolve('./src/css/ecosystem.css'), //
          ],
        },

        // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages#configuration
        pages: {},

        // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap#configuration
        sitemap: {
          ignorePatterns: ['/scripts/**'],
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // https://docusaurus.io/docs/api/themes/configuration
      image: 'img/logos/fastify-black.svg',
      colorMode: {
        respectPrefersColorScheme: true,
      },
      docs: {
        sidebar: {
          autoCollapseCategories: true,
        },
      },
      navbar: {
        title: 'Home',
        logo: {
          alt: 'Fastify Cheetah Logo',
          src: 'img/logos/fastify-black.svg',
          srcDark: 'img/logos/fastify-white.svg',
        },
        items: [
          // {
          //   type: 'docSidebar',
          //   sidebarId: 'docsSidebar',
          //   position: 'left',
          //   label: 'Docs',
          // },
          {
            type: 'doc',
            docId: 'index',
            position: 'left',
            label: 'Docs',
          },
          { to: '/ecosystem', label: 'Ecosystem', position: 'left' },
          { to: '/benchmarks', label: 'Benchmarks', position: 'left' },
          { to: '/organizations', label: 'Adopters', position: 'left' },
          { to: '/contribute', label: 'Contribute', position: 'left' },
          { to: '/resources', label: 'Resources', position: 'left' },
          { to: '/docs/latest/Reference/LTS', label: 'Support', position: 'left' },
          {
            type: 'docsVersionDropdown',
            position: 'right',
          },
          // {
          //   type: 'localeDropdown',
          //   position: 'right',
          // },
          {
            href: 'https://github.com/fastify/fastify',
            position: 'right',
            className: 'header-github-link',
            'aria-label': 'GitHub repository',
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Getting Started',
                to: '/docs/latest/Guides/Getting-Started',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Stack Overflow',
                href: 'https://stackoverflow.com/questions/tagged/fastify',
              },
              {
                label: 'Discord',
                href: 'https://discord.gg/fastify',
              },
              {
                label: 'X',
                href: 'https://x.com/fastifyjs',
              },
            ],
          },
          {
            title: 'More',
            items: [
              // {
              //   label: 'Blog',
              //   to: '/blog',
              // },
              {
                label: 'GitHub',
                href: 'https://github.com/fastify/website',
              },
            ],
          },
        ],
        copyright: `Fastify, Copyright © 2016-${new Date().getFullYear()} <a href="https://openjsf.org">OpenJS Foundation</a> and The Fastify team, Licensed under <a href="https://github.com/fastify/fastify/blob/main/LICENSE">MIT</a>`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
        magicComments: [
          {
            className: 'theme-code-block-highlighted-line',
            line: 'highlight-next-line',
            block: { start: 'highlight-start', end: 'highlight-end' },
          },
          {
            className: 'code-block-error-line',
            line: 'This will error',
          },
        ],
      },

      metadata: [
        // Open Graph / Facebook
        { property: 'og:type', content: 'website' },
        { property: 'og:url', content: 'https://fastify.dev/' },
        { property: 'og:title', content: 'Fastify - Fast and Low Overhead Web Framework' },
        { property: 'og:description', content: 'Fastify is a fast and low overhead web framework for Node.js.' },
        { property: 'og:image', content: 'https://fastify.dev/img/logos/fastify-black.svg' },
        { property: 'og:image:width', content: '1200' },
        { property: 'og:image:height', content: '630' },
        { property: 'og:image:alt', content: 'Fastify Logo' },
        { property: 'og:site_name', content: 'Fastify' },
        { property: 'og:locale', content: 'en_US' },

        // Twitter
        { name: 'twitter:card', content: 'summary_large_image' },
        { name: 'twitter:url', content: 'https://fastify.dev/' },
        { name: 'twitter:title', content: 'Fastify - Fast and Low Overhead Web Framework' },
        { name: 'twitter:description', content: 'Fastify is a fast and low overhead web framework for Node.js.' },
        { name: 'twitter:image', content: 'https://fastify.dev/img/logos/fastify-black.svg' },

        // Telegram (non-standard but harmless)
        { property: 'telegram:title', content: 'Fastify - Fast and Low Overhead Web Framework' },
        { property: 'telegram:description', content: 'Fastify is a fast and low overhead web framework for Node.js.' },
        { property: 'telegram:image', content: 'https://fastify.dev/img/logos/fastify-black.svg' },
      ],
    }),

  plugins: [
    '@orama/plugin-docusaurus-v3',
    [
      // This plugin does not work in dev mode
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          {
            from: '/organisations',
            to: '/organizations',
          },
        ],
        // @ts-expect-error provided types doesn't match the real possible configuration
        createRedirects(existingPath) {
          // Legacy/Retro compatibility:

          // Redirect for old /docs/master/ URLs
          if (existingPath.startsWith('/docs/latest')) {
            return existingPath.replace('/docs/latest', '/docs/master')
          }

          // Redirect for old /docs/v3.<x>.<y>/ URLs to the latest v3 version
          if (existingPath.startsWith('/docs/v3')) {
            // @ts-expect-error provided types doesn't match the real possible configuration
            return u.manageRedirects({
              existingPath,
              major: '3',
              versions,
              versionsShipped: require('./versions-shipped.json'),
              ignore: ['/docs/v3.29.x/Reference/', '/docs/v3.29.x/Guides/'],
            })
          }

          // Redirect for old /docs/v2.<x>.<y>/ URLs to the latest v2 version
          if (existingPath.startsWith('/docs/v2')) {
            // @ts-expect-error provided types doesn't match the real possible configuration
            return u.manageRedirects({
              existingPath,
              major: '2',
              versions,
              versionsShipped: require('./versions-shipped.json'),
            })
          }

          return undefined
        },
      },
    ],
    [
      '@signalwire/docusaurus-plugin-llms-txt',
      {
        content: {
          includePages: true,
          enableLlmsFullTxt: true,
          excludeRoutes: ['/__docusaurus/**'],
        },
      },
    ],
  ],
}

module.exports = config