docusaurus.config.js

const defaultLocale = 'en';
const locales = ['en', 'ru', 'es', 'fr', 'de', 'it', 'ja', 'ko', 'pt', 'zh', 'sr'];
// `docusaurus start` without --locale sets this env var to the string "undefined".
const currentLocale = locales.includes(process.env.DOCUSAURUS_CURRENT_LOCALE)
  ? process.env.DOCUSAURUS_CURRENT_LOCALE
  : defaultLocale;

// The main website serves English at / and other languages at /<locale>/.
const websiteUrl = (path = '/') =>
  `https://semaphoreui.com${currentLocale === defaultLocale ? '' : `/${currentLocale}`}${path}`;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Semaphore UI',
  tagline: 'Modern UI and powerful API for Ansible, Terraform, OpenTofu, PowerShell and other DevOps tools',
  favicon: 'img/favicon.png',

  // Set the production url of your site here
  url: 'https://semaphoreui.com',
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: '/docs/',
  //trailingSlash: true,

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'semaphoreui', // Usually your GitHub org/user name.
  projectName: 'semaphore-docs', // Usually your repo name.

  // Broken links and anchors fail the build. Any page move must be accompanied
  // by an entry in redirects.js, see the comment in that file.
  onBrokenLinks: 'throw',
  onBrokenAnchors: 'throw',
  onBrokenMarkdownLinks: 'warn',

  // 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,
    locales,
    localeConfigs: {
      en: { label: 'English', htmlLang: 'en' },
      ru: { label: 'Русский', htmlLang: 'ru' },
      es: { label: 'Español', htmlLang: 'es' },
      fr: { label: 'Français', htmlLang: 'fr' },
      de: { label: 'Deutsch', htmlLang: 'de' },
      it: { label: 'Italiano', htmlLang: 'it' },
      ja: { label: '日本語', htmlLang: 'ja' },
      ko: { label: '한국어', htmlLang: 'ko' },
      pt: { label: 'Português', htmlLang: 'pt' },
      zh: { label: '中文', htmlLang: 'zh-Hans' },
      sr: { label: 'Srpski', htmlLang: 'sr' },
    },
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: './sidebars.js',
          routeBasePath: '/',
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl:
            'https://github.com/semaphoreui/semaphore-docs/edit/main/',
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // Replace with your project's social card
      image: 'img/docusaurus-social-card.jpg',
      navbar: {
        title: 'Semaphore UI',
        logo: {
          alt: 'Semaphore UI Logo',
          src: 'img/logo.svg',
        },
        items: [
          {
            type: 'dropdown',
            label: 'Product',
            position: 'left',
            items: [
              {
                label: 'Pro · For teams',
                href: websiteUrl('/pro'),
                target: '_self',
              },
              {
                label: 'Enterprise · For large-scale operations',
                href: websiteUrl('/enterprise'),
                target: '_self',
              },
              {
                label: 'Community · For homelab',
                href: 'https://github.com/semaphoreui/semaphore',
                target: '_self',
              },
            ],
          },
          {
            type: 'dropdown',
            label: 'Explore',
            position: 'left',
            items: [
              {
                label: 'Features',
                href: websiteUrl('/features'),
                target: '_self',
              },
              {
                label: 'Use cases',
                href: websiteUrl('/use-cases'),
                target: '_self',
              },
              {
                label: 'Case studies',
                href: websiteUrl('/case-studies'),
                target: '_self',
              },
              {
                label: 'Blog',
                href: websiteUrl('/blog/'),
                target: '_self',
              },
              {
                type: 'html',
                value: '<div class="dropdown__category">Comparison</div>',
              },
              {
                label: 'Semaphore UI vs AWX',
                href: websiteUrl('/vs/awx'),
                target: '_self',
              },
              {
                label: 'Semaphore UI vs Rundeck',
                href: websiteUrl('/vs/rundeck'),
                target: '_self',
              },
              {
                label: 'Semaphore UI vs GitLab',
                href: websiteUrl('/vs/gitlab'),
                target: '_self',
              },
              {
                label: 'Semaphore UI vs Jenkins',
                href: websiteUrl('/vs/jenkins'),
                target: '_self',
              },
              {
                label: 'Semaphore UI vs Spacelift',
                href: websiteUrl('/vs/spacelift'),
                target: '_self',
              },
              {
                label: 'Semaphore UI vs Gaia',
                href: websiteUrl('/vs/gaia'),
                target: '_self',
              },
              {
                label: 'Semaphore UI vs Tower (AAP)',
                href: websiteUrl('/vs/tower'),
                target: '_self',
              },
            ],
          },
          {
            type: 'dropdown',
            label: 'Help',
            position: 'left',
            items: [
              {
                label: 'Installation',
                href: websiteUrl('/install'),
                target: '_self',
              },
              {
                label: 'Docs',
                to: '/',
              },
              {
                label: 'API References',
                href: websiteUrl('/api-docs/'),
                target: '_self',
              },
            ],
          },
          {
            label: 'Pricing',
            href: websiteUrl('/pricing/'),
            target: '_self',
            position: 'left',
          },
          {
            href: 'https://github.com/semaphoreui/semaphore',
            target: '_self',
            label: 'GitHub',
            position: 'right',
          },
          {
            href: 'https://portal.semaphoreui.com',
            target: '_self',
            label: 'Sign in',
            position: 'right',
          },
          {
            type: 'localeDropdown',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'light',
        links: [
          {
            title: ' ',
            items: [
              {
                html: `
                  <a class="footer__brand" href="${websiteUrl()}" aria-label="Semaphore UI">
                    <img class="footer__logo footer__logo--light" src="/docs/img/semaphore-light.png" alt="Semaphore UI" />
                    <img class="footer__logo footer__logo--dark" src="/docs/img/semaphore-dark.png" alt="Semaphore UI" />
                  </a>
                  <p class="footer__desc">A self-hosted automation control plane for Ansible, Terraform, OpenTofu, Terragrunt, Bash, PowerShell, and Python workflows.</p>
                  <div class="footer__contact">
                    <div class="footer__contactTitle">Contact us</div>
                    <div class="footer__contactRow"><span class="footer__contactLabel">Sales</span><a href="mailto:sales@semaphoreui.com">sales@semaphoreui.com</a></div>
                    <div class="footer__contactRow"><span class="footer__contactLabel">Partnership</span><a href="mailto:partners@semaphoreui.com">partners@semaphoreui.com</a></div>
                    <div class="footer__contactRow"><span class="footer__contactLabel">Support</span><a href="mailto:support@semaphoreui.com">support@semaphoreui.com</a></div>
                    <div class="footer__contactRow"><span class="footer__contactLabel">Security</span><a href="mailto:security@semaphoreui.com">security@semaphoreui.com</a></div>
                    <div class="footer__contactRow"><span class="footer__contactLabel">Legal</span><a href="mailto:legal@semaphoreui.com">legal@semaphoreui.com</a></div>
                  </div>
                `,
              },
            ],
          },
          {
            title: 'Product',
            items: [
              { label: 'Community', href: 'https://github.com/semaphoreui/semaphore', target: '_self' },
              { label: 'Pro', href: websiteUrl('/pro'), target: '_self' },
              { label: 'Enterprise', href: websiteUrl('/enterprise'), target: '_self' },
              { label: 'Pricing', href: websiteUrl('/pricing/'), target: '_self' },
            ],
          },
          {
            title: 'Explore',
            items: [
              { label: 'Features', href: websiteUrl('/features'), target: '_self' },
              { label: 'Use cases', href: websiteUrl('/use-cases'), target: '_self' },
              { label: 'Case studies', href: websiteUrl('/case-studies'), target: '_self' },
              { label: 'Roadmap', href: websiteUrl('/roadmap'), target: '_self' },
              { label: "What's New", href: websiteUrl('/releases/'), target: '_self' },
            ],
          },
          {
            title: 'Help',
            items: [
              { label: 'Installation', href: websiteUrl('/install'), target: '_self' },
              { label: 'Documentation', to: '/' },
              { label: 'API References', href: websiteUrl('/api-docs/'), target: '_self' },
            ],
          },
          {
            title: 'Links',
            items: [
              { label: 'GitHub', href: 'https://github.com/semaphoreui/semaphore', target: '_self' },
              { label: 'X (ex. Twitter)', href: 'https://twitter.com/semaphoreui', target: '_self' },
              { label: 'Discord', href: 'https://discord.gg/5R6k7hNGcH', target: '_self' },
              { label: 'YouTube', href: 'https://www.youtube.com/@semaphoreui', target: '_self' },
              { label: 'LinkedIn', href: 'https://www.linkedin.com/company/semaphoreui', target: '_self' },
              { label: 'Facebook', href: 'https://facebook.com/semaphoreui', target: '_self' },
              { label: 'Snapcraft', href: 'https://snapcraft.io/semaphore', target: '_self' },
            ],
          },
          {
            title: 'Legal',
            items: [
              { label: 'Terms of Service', href: websiteUrl('/legal/terms-of-service'), target: '_self' },
              { label: 'Subscription Agreement', href: websiteUrl('/legal/subscription-agreement'), target: '_self' },
              { label: 'Refund Policy', href: websiteUrl('/legal/refund-policy'), target: '_self' },
              { label: 'Privacy Policy', href: websiteUrl('/privacy/policy'), target: '_self' },
              { label: 'Cookie Policy', href: websiteUrl('/privacy/cookies'), target: '_self' },
              { label: 'Security Whitepaper', href: websiteUrl('/security/whitepaper'), target: '_self' },
              { label: 'Support Offering', href: websiteUrl('/legal/support-offering'), target: '_self' },
            ],
          },
        ],
        copyright: `© ${new Date().getFullYear()} Semaphore UI. All rights reserved.`,
      },
      prism: {
        additionalLanguages: ['powershell', 'bash', 'hcl'],
        theme: require('prism-react-renderer').themes.github,
        darkTheme: require('prism-react-renderer').themes.dracula,
      },
      algolia: {
        // The application ID provided by Algolia
        appId: 'B71NA6DNHD',

        // Public API key: it is safe to commit it
        apiKey: 'bb1dabaeb79b08523ab98c9723afad04',

        indexName: 'docs',

        // Optional: see doc section below
        contextualSearch: false,

        // 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: 'external\\.com|domain\\.com',

        // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl.
        // Uncomment and adjust if your Algolia index was crawled with different URLs
        // replaceSearchResultPathname: {
        //   from: '/docs/', // or as RegExp: /\/docs\//
        //   to: '/',
        // },

        // Optional: Algolia search parameters
        searchParameters: {
          facetFilters: [],
        },
        // Optional: path for search page that enabled by default (`false` to disable it)
        searchPagePath: 'search',

        // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
        insights: false,

        //... other Algolia params
      },
    }),

  plugins: [
    // Redirects from old URLs of moved or removed pages. See redirects.js.
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: require('./redirects'),
      },
    ],
    // Non-default languages reuse the English copy of /docs/assets/* images.
    require('./plugins/shared-locale-assets'),
    // Webpack's persistent cache is keyed by bundle name, mode and locale, but
    // not by the directory Docusaurus generates its modules into. A build that
    // uses a non-default DOCUSAURUS_GENERATED_FILES_DIR_NAME therefore reuses
    // loader output that imports from the *other* directory, and every page
    // fails with "Can't resolve @site/.docusaurus/...". scripts/build-parallel.sh
    // needs both, so it points the cache somewhere of its own through this.
    ...(process.env.SEMAPHORE_DOCS_WEBPACK_CACHE_DIR ? [
    function separateWebpackCache() {
      return {
        name: 'separate-webpack-cache',
        configureWebpack() {
          return {
            cache: {cacheDirectory: process.env.SEMAPHORE_DOCS_WEBPACK_CACHE_DIR},
          };
        },
      };
    },
    ] : []),
    ...(process.env.SEMAPHORE_DOCS_DEV_PROXY === 'true' ? [
    function localizedDevSocket(context) {
      const socketPath = `${context.baseUrl}__webpack_hmr`;
      return {
        name: 'localized-dev-socket',
        configureWebpack() {
          return {
            devServer: {
              client: { webSocketURL: { pathname: socketPath } },
              webSocketServer: { type: 'ws', options: { path: socketPath } },
            },
          };
        },
      };
    },
    ] : []),
  ],


  markdown: {
    mermaid: true,
  },
  themes: ['@docusaurus/theme-mermaid'],
};

export default config;