docusaurus.config.js

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const {themes} = require('prism-react-renderer');
const lightTheme = themes.github;
const darkTheme = themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Replicated',
  tagline: 'Technical documentation for Replicated vendors and their enterprise end-customers.',
  url: 'https://docs.replicated.com',
  baseUrl: '/',
  onBrokenLinks: 'warn',
  favicon: 'images/favicon.png',
  markdown: {
    hooks: {
      onBrokenMarkdownLinks: 'warn',
    },
  },
  organizationName: 'replicatedhq', // Usually your GitHub org/user name.
  projectName: 'replicated-docs', // Usually your repo name.
  trailingSlash: false,
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: '/', // Serve the docs at the site's root
          sidebarPath: require.resolve('./sidebars.js'),
          breadcrumbs: true,
          editUrl: 'https://github.com/replicatedhq/replicated-docs/edit/main/',
          admonitions: {
            keywords: ['note','important', 'tip', 'info', 'caution', 'danger'],
            extendDefaults: true,
          },
        },
        googleAnalytics: {
          trackingID: 'UA-61420213-25',
          anonymizeIP: true,
        },
        gtag: {
          trackingID: 'G-MBWBP4JW70',
          anonymizeIP: true,
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],
  plugins: [
    '@docsearch/docusaurus-adapter',
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'embedded-cluster',
        path: 'embedded-cluster',
        routeBasePath: 'embedded-cluster',
        sidebarPath: './sidebarEmbeddedCluster.js',
        breadcrumbs: true,
        editUrl: 'https://github.com/replicatedhq/replicated-docs/edit/main/',
        // Versioning configuration
        lastVersion: 'current', // v3 is the default version
        includeCurrentVersion: true, // Include the "next" version from installer/ folder
        versions: {
          current: {
            label: 'Embedded Cluster v3',
            path: 'v3',
            banner: 'none',
            badge: false,
          },
          '2.0.0': {
            label: 'Embedded Cluster v2',
            path: 'v2',
            banner: 'unmaintained',
            badge: false,
          },
        },
      },
    ],
  ],
  scripts: [
    {
      src:
        '/js/activecampaign.js',
      async: true,
    },
    {
      src:
        '/js/visitoranalytics.js',
      async: true,
    },
    {
      src:
        '/js/commonroom.js',
      async: true,
    },
  ],
  
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      docs: {
        sidebar: {
          hideable: true,
        },
      },
      docsearch: {
        // The application ID provided by Algolia
        appId: 'GHHO0O7LF5',

        // Public API key: it is safe to commit it
        apiKey: '94355b8c51360cebbfff7519ab737aa8',
        indexName: 'Replicated Docs',
        askAi: {
          assistantId: '3d7bee1a-53a3-4fee-bbd2-86ade3b1959a',
          agentStudio: true,
          sidePanel: {
            translations: {
              newConversationScreen: {
                introductionText:
                  'I search the Replicated documentation to help you find onboarding guides, product details, reference material, and more.',
              },
            },
          },
        },
      },
      navbar: {
        title: 'Docs',
        logo: {
          alt: 'R',
          src: 'images/logo-replicated-red.png',
        },
        items: [
          {
            type: 'dropdown',
            label: 'Release notes',
            position: 'left',
            items: [
              {
                type: 'doc',
                docId: 'release-notes/rn-embedded-cluster-v3',
                label: 'Embedded Cluster v3',
              },
              {
                type: 'doc',
                docId: 'release-notes/rn-embedded-cluster',
                label: 'Embedded Cluster v2',
              },
              {
                type: 'doc',
                docId: 'release-notes/rn-app-manager',
                label: 'KOTS',
              },
              {
                type: 'doc',
                docId: 'release-notes/rn-kubernetes-installer',
                label: 'kURL',
              },
              {
                type: 'doc',
                docId: 'release-notes/rn-replicated-sdk',
                label: 'Replicated SDK',
              },
              {
                type: 'doc',
                docId: 'release-notes/rn-vendor-platform',
                label: 'Vendor Platform',
              },
            ],  
          },
          {
            type: 'dropdown',
            label: 'Product docs',
            position: 'left',
            items: [
              {
                type: 'doc',
                docId: 'vendor/testing-about',
                label: 'Compatibility Matrix',
              },
              {
                type: 'doc',
                docId: 'embedded-overview',
                docsPluginId: 'embedded-cluster',
                label: 'Embedded Cluster',
              },
              {
                type: 'doc',
                docId: 'vendor/enterprise-portal-about',
                label: 'Enterprise Portal',
              },
              {
                type: 'doc',
                docId: 'intro-kots',
                label: 'KOTS',
              },
              {
                type: 'doc',
                docId: 'vendor/kurl-about',
                label: 'kURL',
              },
              {
                type: 'doc',
                docId: 'vendor/private-images-about',
                label: 'Replicated proxy registry',
              },
              {
                type: 'doc',
                docId: 'vendor/replicated-sdk-overview',
                label: 'Replicated SDK',
              },
              {
                type: 'doc',
                docId: 'vendor/vendor-portal-creating-account',
                label: 'Vendor Portal',
              },
            ],  
          },
          {
            type: 'dropdown',
            label: 'Reference',
            position: 'left',
            items: [
              {
                type: 'doc',
                docId: 'reference/custom-resource-about',
                label: 'Custom resources',
              },
              {
                type: 'doc',
                docId: 'reference/template-functions-about',
                label: 'Template functions',
              },
              {
                type: 'doc',
                docId: 'reference/kots-cli-getting-started',
                label: 'KOTS CLI',
              },
              {
                type: 'doc',
                docId: 'reference/replicated-cli-installing',
                label: 'Replicated CLI',
              },
              {
                type: 'doc',
                docId: 'reference/replicated-sdk-apis',
                label: 'Replicated SDK API',
              },
              {
                type: 'doc',
                docId: 'reference/vendor-api-using',
                label: 'Vendor API v3',
              },
            ],  
          },
        ],
      },
      footer: {
        style: 'dark',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Release notes',
                to: 'release-notes/rn-whats-new',
              },
              {
                label: 'Replicated Onboarding',
                to: 'vendor/replicated-onboarding',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              {
                label: 'Discourse',
                href: 'https://community.replicated.com',
              },
              {
                label: 'Twitter',
                href: 'https://twitter.com/replicatedhq',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'Blog',
                to: 'https://replicated.com/blog',
              },
              {
                label: 'GitHub',
                href: 'https://github.com/replicatedhq',
              },
            ],
          },
        ],
        copyright: `© ${new Date().getFullYear()} Replicated, Inc. All Rights Reserved.`,
      },
      prism: {
        theme: lightTheme,
        darkTheme: darkTheme,
        additionalLanguages: ['bash'],
      },
    }),
};

module.exports = config;