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

const config: Config = {
  title: 'Conduit | Data Integration for Production Data Stores',
  tagline: 'Sync data between your production systems using an extensible, event-first experience with minimal dependencies that fit within your existing workflow for free.',
  favicon: 'img/favicon.ico',
  
  // Set the production url of your site here
  url: 'https://conduit.io',
  // 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: 'conduitio', // Usually your GitHub org/user name.
  projectName: 'conduit-site', // Usually your repo name.
  
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  onDuplicateRoutes: 'warn',
  
  markdown: {
    mermaid: true,
  },
  themes: ['@docusaurus/theme-mermaid'],
  
  // 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: [
    [
      '@docusaurus/preset-classic',
      {
        gtag: {
          trackingID: 'G-QKF0TW3J6Z',
          anonymizeIP: true,
        },
        docs: {
          sidebarPath: './src/sidebars/sidebars.ts',
          editUrl: 'https://github.com/conduitio/conduit-site/edit/main/',
          showLastUpdateTime: true,
        },
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],
  
  themeConfig: {
    metadata: [{ name: 'facebook-domain-verification', content: '0aq4u2ydyv4axal6x65gslmidlhc7j' }],
    image: 'img/generic-social-image.png',
    navbar: {
      logo: {
        alt: 'Conduit Logo',
        src: 'img/conduit/on-white-conduit-logo.png',
      },
      items: [
        { to: '/', label: 'Home', position: 'left', activeBaseRegex: `///` },
        { to: '/docs', position: 'left', label: 'Documentation' },
        { to: '/changelog', position: 'left', label: 'Changelog' },
        { to: '/api', label: 'HTTP API', position: 'left' },
        { href: 'https://meroxa.io', label: 'Conduit Platform', position: 'right', class: 'navbar__link navbar__item conduit-platform' },
        { href: 'https://meroxa.com/blog/?type=Conduit', position: 'right', label: 'Blog' },
      ],
    },
    algolia: { // https://docusaurus.io/docs/search#using-algolia-docsearch
      // The application ID provided by Algolia
      appId: '37HOKUPXLR', // 
      
      // Search API key: it is safe to commit it
      apiKey: '6a3c0c5d80ffbcba9eb001201f9128b8',
      
      indexName: 'conduit',
      
      // Facets could be configured via https://dashboard.algolia.com/apps/37HOKUPXLR/explorer/configuration/conduit/facets. It's important to note that the facets need to be enabled in the Algolia dashboard.
      contextualSearch: false,
      // searchParameters: {
      //   facetFilters: ['language:en', ''],
      // },
      
      // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
      // externalUrlRegex: '',
      
      // Optional: Algolia search parameters
      // searchParameters: {},
      
      // This creates a custom page where the search is displayed. This can be useful when sharing a specific list of urls.
      searchPagePath: 'docs/search', // 
      
      // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
      insights: true,
    },
    footer: {
      style: 'dark',
      links: [
        {
          items: [
            {
              html: `
                <a href="/" class="text-black hover:text-gray-600">
                  <img id="footer-logo" src="/img/conduit/conduit-logo.svg" width="178" height="70" alt="Conduit Logo" />
                </a>
              `
            },
            {
              html: `
                <div class='flex mt-6'>
                  <a href='https://x.com/ConduitIO'>
                  <svg width="35px" height="35px" viewBox="0 0 35 35" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <title>Shape</title>
    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
        <g id="logo" fill="#000" fill-rule="nonzero">
            <path d="M20.3818627,14.8201114 L33.1312328,0 L30.1100402,0 L19.0397637,12.8680945 L10.1979664,0 L0,0 L13.3705325,19.4588379 L0,35 L3.02136386,35 L14.711861,21.4108548 L24.0494467,35 L34.2474131,35 L20.3811207,14.8201114 L20.3818627,14.8201114 Z M16.2436907,19.6302747 L14.8889772,17.6926132 L4.11000351,2.2744392 L8.75064214,2.2744392 L17.4493994,14.7173977 L18.804113,16.6550592 L30.1114672,32.8289994 L25.4708285,32.8289994 L16.2436907,19.6310167 L16.2436907,19.6302747 Z" id="Shape"></path>
        </g>
    </g>
</svg>
                  </a>
                  <a href='https://github.com/ConduitIO/' class='text-black ml-4'>
                    <svg aria-label="ConduitIO on GitHub" width="35" height="35" viewBox="0 0 72 70" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0)"><path fill-rule="evenodd" clip-rule="evenodd" d="M36 0C55.8895 0 72 16.0623 72 35.8923C72 51.7564 61.6796 65.1967 47.3812 69.9559C45.5912 70.2864 44.9282 69.1848 44.9282 68.2153C44.9282 67.356 44.9503 65.1086 44.9724 62.112C54.9834 64.2713 57.105 57.3088 57.105 57.3088C58.7403 53.1665 61.105 52.0428 61.105 52.0428C64.3757 49.8174 60.8619 49.8615 60.8619 49.8615C57.2597 50.1259 55.337 53.5631 55.337 53.5631C52.1326 59.0494 46.9171 57.463 44.8619 56.5376C44.5304 54.2241 43.6022 52.6377 42.5856 51.7343C50.5635 50.853 58.9613 47.7683 58.9613 34.0195C58.9613 30.0976 57.5691 26.9027 55.2486 24.3909C55.6243 23.4655 56.8619 19.83 54.9171 14.8946C54.9171 14.8946 51.8895 13.9251 45.0166 18.5741C42.1436 17.7809 39.0718 17.3843 36 17.3623C32.9503 17.3843 29.8564 17.7809 26.9834 18.5741C20.1105 13.9251 17.0829 14.8946 17.0829 14.8946C15.116 19.83 16.3536 23.4876 16.7293 24.3909C14.4309 26.9027 13.0387 30.0976 13.0387 34.0195C13.0387 47.8124 21.4586 50.831 29.4807 51.7343C28.1989 52.836 27.0276 55.0393 27.0276 58.3884C27.0276 63.1917 27.0718 67.0475 27.0718 68.2373C27.0718 69.2068 26.4309 70.3085 24.5967 69.9559C10.2983 65.1967 0 51.7564 0 35.9144C0 16.0623 16.1105 0 36 0Z" fill="currentColor"></path></g><defs><clipPath id="clip0"><rect width="72" height="70" fill="white"></rect></clipPath></defs></svg>
                  </a>
                  <a href='https://discord.meroxa.com' class='ml-4'>
                    <svg aria-label="Join our Discord" width="45" height="35" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#discord-clipPath)"><path d="M38.248 3.117A37.258 37.258 0 0 0 29.052.264a.14.14 0 0 0-.148.07 25.924 25.924 0 0 0-1.145 2.352 34.397 34.397 0 0 0-10.33 0A23.784 23.784 0 0 0 16.268.334a.145.145 0 0 0-.148-.07 37.155 37.155 0 0 0-9.197 2.853.132.132 0 0 0-.06.052C1.004 11.919-.6 20.455.187 28.885c.003.042.026.081.058.106 3.865 2.838 7.609 4.561 11.283 5.703a.146.146 0 0 0 .158-.052 26.79 26.79 0 0 0 2.308-3.754.143.143 0 0 0-.078-.199 24.679 24.679 0 0 1-3.525-1.68.145.145 0 0 1-.014-.24c.237-.178.474-.362.7-.549a.14.14 0 0 1 .146-.02c7.394 3.376 15.4 3.376 22.707 0a.14.14 0 0 1 .147.018c.227.187.464.373.702.55a.145.145 0 0 1-.012.241 23.16 23.16 0 0 1-3.527 1.678.144.144 0 0 0-.076.201 30.078 30.078 0 0 0 2.306 3.752c.036.05.1.072.159.054 3.691-1.142 7.435-2.865 11.3-5.703a.145.145 0 0 0 .058-.104c.942-9.746-1.578-18.212-6.68-25.716a.115.115 0 0 0-.059-.054Zm-23.15 20.635c-2.226 0-4.06-2.043-4.06-4.553s1.798-4.554 4.06-4.554c2.28 0 4.096 2.061 4.06 4.554 0 2.51-1.798 4.553-4.06 4.553Zm15.013 0c-2.226 0-4.06-2.043-4.06-4.553s1.799-4.554 4.06-4.554c2.28 0 4.096 2.061 4.06 4.554 0 2.51-1.78 4.553-4.06 4.553Z" fill="#5865F2"/></g><defs><clipPath id="discord-clipPath"><path fill="#fff" d="M0 0h45.182v35H0z"/></clipPath></defs></svg>
                  </a>
                </div>
              `
            }
          ]
        },
        {
          title: 'Resources',
          items: [
            { label: 'Connectors', to: '/docs/using/connectors/list' },
            { label: 'Documentation', to: '/docs' },
            { label: 'Issues', href: 'https://github.com/ConduitIO/conduit/issues' },
            { label: 'Changelog', to: '/changelog' },
            { label: 'GitHub Discussions', href: 'https://github.com/ConduitIO/conduit/discussions' },
            { label: 'Conduit X', href: 'https://x.com/conduitio' },
          ],
        },
        {
          title: 'Company',
          items: [
            { label: 'About Meroxa', href: 'https://meroxa.com/about' },
            { label: 'Blog', href: 'https://meroxa.com/blog/?type=Conduit' },
            { label: 'Careers', href: 'https://jobs.lever.co/meroxa' },
            { label: 'Join our Discord', href: 'https://discord.meroxa.com' },
            { label: 'Meroxa X', href: 'https://x.com/meroxadata' },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Meroxa, Inc.`,
    },
    announcementBar: {
      id: 'announcement-bar-6', // increment on change
      content: `Conduit v0.12.2 is here! <a class='cta' href='/changelog/2024-11-08-conduit-0-12-2-release' target='_blank' rel='noreferrer noopener'>See what's new</a>.`,
      isCloseable: true,
    },
    colorMode: {
      defaultMode: 'light',
      disableSwitch: true,
      respectPrefersColorScheme: false,
    },
    prism: {
      theme: prismThemes.dracula,
      additionalLanguages: ['bash', 'diff', 'json', 'hcl', 'yaml'],
    },
  } satisfies Preset.ThemeConfig,
  plugins: [
    async function tailwindPlugin(context, options) {
      return {
        name: "docusaurus-tailwindcss",
        injectHtmlTags() {
          return {
            headTags: [
              {
                tagName: "link",
                attributes: {
                  rel: "stylesheet",
                  href: "https://cdn.jsdelivr.net/npm/tailwindcss/dist/preflight.min.css",
                },
              },
            ],
          };
        },
        configurePostCss(postcssOptions) {
          // Appends TailwindCSS and AutoPrefixer.
          postcssOptions.plugins.push(require("tailwindcss"));
          postcssOptions.plugins.push(require("autoprefixer"));
          return postcssOptions;
        },
      };
    },
    [
      '@docusaurus/plugin-content-blog',
      {
        id: 'changelog',
        routeBasePath: 'changelog',
        path: './changelog',
        onUntruncatedBlogPosts: 'ignore',
        onInlineAuthors: 'ignore',
        onInlineTags: 'ignore',
        blogSidebarCount: 'ALL'
      },
    ],
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          {
            from: '/docs/connectors/connector-list',
            to: '/docs/using/connectors/list',
          },
          {
            from: '/docs/connectors/building-connectors',
            to: '/docs/developing/connectors',
          },
          {
            from: '/docs/connectors/building/',
            to: '/docs/developing/connectors',
          },
          {
            from: '/docs/connectors/installing',
            to: '/docs/using/connectors/installing',
          },
          {
            from: '/docs/connectors/referencing/',
            to: '/docs/using/connectors/referencing',
          },
          {
            from: '/docs/connectors/additional-built-in-plugins/',
            to: '/docs/using/connectors/additional-built-in-plugins'
          },
          {
            from: '/docs/pipeline-configuration-files/getting-started',
            to: '/docs/using/pipelines/configuration-file',
          },
          {
            from: '/docs/features/opencdc-record',
            to: '/docs/using/opencdc-record',
          },
          {
            from: '/docs/processors',
            to: '/docs/using/processors/getting-started',
          },
          {
            from: '/docs/processors/getting-started',
            to: '/docs/using/processors/getting-started',
          },
          {
            from: '/docs/processors/builtin/',
            to: '/docs/using/processors/builtin',
          },
          {
            from: '/docs/processors/standalone/building',
            to: '/docs/developing/processors/building',
          },
          {
            from: '/docs/processors/referencing-fields',
            to: '/docs/using/processors/referencing-fields',
          },
          {
            from: '/docs/features/schema-support',
            to: '/docs/using/other-features/schema-support',
          },
          {
            from: '/docs/features/pipeline-semantics',
            to: '/docs/core-concepts/pipeline-semantics',
          },
          {
            from: '/docs/pipeline-configuration-files',
            to: '/docs/using/pipelines/configuration-file',
          },
          {
            from: '/docs/features/stream-inspector',
            to: '/docs/using/other-features/stream-inspector'
          },
        ]
      },
    ],
  ],
};

export default config;