gitlink_help_center/docusaurus.config.js

const copyright = '2021-present © BoxyHQ Inc.';

/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
  title: 'Security Building Blocks for Developers',
  tagline:
    'BoxyHQ helps startups enable enterprise features in any SaaS app with just a few lines of code. Integrate SAML, Audit Logs, Privacy Vault and Role Based Access in minutes. Open source and free.',
  url: 'https://boxyhq.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'throw',
  favicon: 'img/favicon.ico',
  organizationName: 'boxyhq', // Usually your GitHub org/user name.
  projectName: 'website', // Usually your repo name.
  scripts: [],
  // stylesheets: ['styles/dark-mode.css'],
  themeConfig: {
    prism: {
      theme: require('prism-react-renderer/themes/dracula'),
      additionalLanguages: ['php'],
    },
    zoom: {
      selector: '.markdown :not(em) > img',
      config: {
        background: {
          light: 'rgb(255, 255, 255)',
          dark: 'rgb(50, 50, 50)',
        },
      },
    },
    announcementBar: {
      id: 'announcement-bar',
      content:
        '<a target="_blank" rel="nofollow noopener noreferrer" href="https://github.com/boxyhq/jackson">⭐ Star Enterprise SSO on GitHub</a>     <a target="_blank" rel="nofollow noopener noreferrer" href="https://github.com/retracedhq/retraced">⭐ Star Audit Logs on GitHub</a>',
      isCloseable: false,
    },
    image: 'img/website-preview-image.png',
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: 'BoxyHQ',
      logo: {
        alt: 'BoxyHQ',
        width: '32px',
        height: '32px',
        src: 'img/logo.png',
        srcDark: 'img/logo-dark.png',
      },
      items: [
        {
          label: 'Products',
          type: 'dropdown',
          items: [
            {
              to: '/enterprise-sso',
              label: 'Enterprise SSO',
            },
            {
              to: '/directory-sync',
              label: 'Directory Sync',
            },
            {
              to: '/audit-logs',
              label: 'Audit Logs',
            },
            {
              to: '/privacy-vault',
              label: 'Privacy Vault',
            },
            { to: '/saas-registration', label: 'SaaS Early Access' },
          ],
        },
        {
          label: 'Developers',
          type: 'dropdown',
          items: [
            { to: '/docs', label: 'Docs' },
            { to: '/guides', label: 'Guides' },
            { to: '/enterprise-readiness', label: 'Enterprise Readiness' },
            {
              href: 'https://mocksaml.com',
              label: 'Mock SAML',
            },
            {
              href: 'https://github.com/boxyhq/saas-starter-kit',
              label: 'Enterprise SaaS Starter Kit',
            },
            {
              href: 'https://awesome-oss-devsec.boxyhq.com',
              label: 'Developer Security Tools',
            },
          ],
        },
        { to: '/blog', label: 'Blog' },
        { to: '/pricing', label: 'Pricing' },
        {
          label: 'Company',
          type: 'dropdown',
          position: 'right',
          items: [
            {
              to: '/careers',
              label: 'Careers',
            },
            {
              to: '/team',
              label: 'Team',
            },
            {
              to: '/pledge',
              label: 'Pledge',
            },
          ],
        },
        {
          href: 'https://github.com/boxyhq',
          position: 'right',
          className: 'header-github-link',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Community',
          items: [
            {
              label: 'GitHub',
              href: 'https://github.com/boxyhq',
            },
            {
              label: 'Discord',
              href: 'https://discord.boxyhq.com',
            },
            {
              label: 'Twitter',
              href: 'https://twitter.com/boxyhq',
            },
            {
              label: 'OSS Friends',
              href: 'https://boxyhq.com/oss-friends',
            },
          ],
        },
        {
          title: 'Social',
          items: [
            {
              label: 'LinkedIn',
              href: 'https://www.linkedin.com/company/boxyhq',
            },
            {
              label: 'Facebook',
              href: 'https://www.facebook.com/boxyhq',
            },
            {
              label: 'Instagram',
              href: 'https://www.instagram.com/boxyhq',
            },
          ],
        },
        {
          title: 'Legal',
          items: [
            {
              label: 'Privacy & Cookies Policy',
              href: '/privacy.html',
            },
            {
              label: 'Terms',
              href: '/terms.html',
              target: '_blank',
            },
          ],
        },
        {
          title: 'Company',
          items: [
            {
              label: 'Careers',
              href: '/careers',
            },
            {
              label: 'Team',
              href: '/team',
            },
          ],
        },
      ],
      copyright,
    },
  },
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
        },
        blog: {
          blogTitle: 'Blog',
          blogDescription:
            'The BoxyHQ blog is where our team shares our thoughts and ideas about everything from our products to industry news and insights. We also welcome guest posts so please do get in touch if you have any thoughts you would like to share on our blog.',
          showReadingTime: true,
          feedOptions: {
            type: 'all',
            copyright,
          },

          blogSidebarTitle: 'Recent posts',
          blogSidebarCount: 5,
          postsPerPage: 'ALL',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      },
    ],
  ],
  plugins: [
    [
      require.resolve('docusaurus-gtm-plugin'),
      {
        id: 'GTM-N9999D3', // GTM Container ID
      },
    ],
    [
      '@docusaurus/plugin-content-blog',
      {
        /**
         * Required for any multi-instance plugin
         */
        id: 'careers',
        /**
         * URL route for the blog section of your site.
         * *DO NOT* include a trailing slash.
         */
        routeBasePath: 'careers',
        /**
         * Path to data on filesystem relative to site dir.
         */
        path: './careers',
        blogTitle: 'Careers',
        blogDescription:
          'Join us on our mission to help startups simplify the development of compliance and data security-related features in their products. Check out our open roles.',
      },
    ],
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'guides',
        path: 'guides',
        routeBasePath: 'guides',
        sidebarPath: require.resolve('./sidebars_guides.js'),
      },
    ],
    ['@cmfcmf/docusaurus-search-local', {}],
    require.resolve('docusaurus-plugin-image-zoom'),
    [
      '@docusaurus/plugin-client-redirects',
      {
        redirects: [
          {
            from: '/docs/jackson/admin-ui',
            to: '/docs/admin-portal/enterprise-sso',
          },
          {
            from: '/docs/directory-sync/admin-ui',
            to: '/docs/admin-portal/directory-sync',
          },
          {
            from: '/docs/jackson/saml-flow',
            to: '/docs/jackson/sso-flow',
          },
          {
            from: '/docs/jackson/configure-saml-idp',
            to: '/docs/jackson/sso-providers',
          },
          {
            from: '/docs/jackson/deploy/pre-loaded-configuration',
            to: '/docs/jackson/deploy/pre-loaded-connections',
          },
        ],
      },
    ],
  ],
};