docusaurus.config.js

/* eslint-disable prettier/prettier */
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

// const passboltTheme = require('./src/lib/prism-passbolt');
import { themes as prismThemes } from 'prism-react-renderer';
import footerLinks from './data/footer.json';

const ROUTES = {
  HELPSITE_URL: 'https://www.passbolt.com/docs',
  WEBSITE_URL: 'https://www.passbolt.com',
  BLOG_URL: 'https://blog.passbolt.com',
  CAREERS_URL: 'https://careers.passbolt.com',
  FORUM_URL: 'https://community.passbolt.com',
  REDDIT_URL: 'https://www.reddit.com/r/passbolt',
  GITHUB_URL: 'https://github.com/passbolt/passbolt-docs',
  GITHUB_ORG_URL: 'https://github.com/passbolt',
  X_URL: 'https://x.com/passbolt',
  LINKEDIN_URL: 'https://www.linkedin.com/company/passbolt',
  YOUTUBE_URL: 'https://www.youtube.com/user/passboltpassword',
  MASTODON_URL: 'https://mastodon.social/@passbolt',
};

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Passbolt documentation.',
  tagline: 'Everything you need to optimize the way you work with Passbolt.',
  favicon: 'img/favicon.ico',

  // Set the production url of your site here
  url: process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : ROUTES.WEBSITE_URL,
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: process.env.VERCEL_URL ? '/' : '/docs/',

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

  onBrokenLinks: process.env.VERCEL_URL ? 'warn' : 'throw',
  onBrokenMarkdownLinks: process.env.VERCEL_URL ? 'warn' : 'throw',

  // Even if you don't use internalization, 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'],
  },
  trailingSlash: true,
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars/index.js'),
          showLastUpdateTime: true,
          showLastUpdateAuthor: false,
          editUrl: 'https://github.com/passbolt/passbolt-docs/blob/main',
        },
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        sitemap: {
          ignorePatterns: ['/docs/components/**', '/docs/development/**'],
        },
      }),
    ],
    [
      'redocusaurus',
      /** @type {import('redocusaurus').PresetEntry} */
      {
        specs: [
          {
            spec: 'openapi/root.yml',
            route: '/api'
          },
        ],
      },
    ],
  ],
  customFields: {
    footer: {
      slogan:
        'Open source password and credential manager for teams. The all-in-one solution for all types of credentials and built for secure collaboration. Passbolt is versatile and can be self-hosted or cloud-hosted. Built for modern tech teams, trusted by mission-critical organisations, usable by everyone.',
      socialMedia: {
        links: [
          {
            href: ROUTES.GITHUB_ORG_URL,
            icon: {
              alt: 'Our Github account',
              src: 'icons/github.svg',
              width: 20,
              height: 20,
            },
          },
          {
            href: ROUTES.YOUTUBE_URL,
            icon: {
              alt: 'Our Youtube account',
              src: 'icons/youtube.svg',
              width: 26,
              height: 18,
            },
          },
          {
            href: ROUTES.X_URL,
            icon: {
              alt: 'Our X account',
              src: 'icons/x.svg',
              width: 19.92,
              height: 18,
            },
          },
          {
            href: ROUTES.LINKEDIN_URL,
            icon: {
              alt: 'Our LinkedIn account',
              src: 'icons/linkedin.svg',
              width: 20,
              height: 20,
            },
          },
          {
            href: ROUTES.MASTODON_URL,
            icon: {
              alt: 'Our Mastodon account',
              src: 'icons/mastodon.svg',
              width: 19.13,
              height: 20,
            },
          },
          {
            href: ROUTES.REDDIT_URL,
            icon: {
              alt: 'Our Reddit account',
              src: 'icons/reddit.svg',
              width: 20,
              height: 20,
            },
          },
          {
            href: ROUTES.FORUM_URL,
            icon: {
              alt: 'Our Forum',
              src: 'icons/discourse.svg',
              width: 19.42,
              height: 20,
            },
          },
        ],
      },
    },
  },
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        { name: 'og:type', content: 'website' }
      ],
      image: 'img/og.jpg',
      docs: {
        sidebar: {
          autoCollapseCategories: true,
        },
      },
      navbar: {
        logo: {
          alt: 'Passbolt logo',
          src: 'img/logo.svg',
          width: 160,
        },
        items: [
          {
            href: ROUTES.WEBSITE_URL,
            position: 'left',
            className: 'main-website-link',
            title: 'Return to main website',
            label: '←',
          },
          {
            type: 'docSidebar',
            href: '/user',
            sidebarId: 'userGuideSidebar',
            position: 'left',
            label: 'User guide',
          },
          {
            type: 'docSidebar',
            href: '/admin',
            sidebarId: 'adminGuideSidebar',
            position: 'left',
            label: 'Admin guide',
          },
          {
            type: 'docSidebar',
            href: '/hosting',
            sidebarId: 'hostingGuideSidebar',
            position: 'left',
            label: 'Hosting guide',
          },
          {
            href: '/api',
            position: 'left',
            label: 'API guide',
          },
          // {
          //   type: 'docSidebar',
          //   sidebarId: 'contributeGuideSidebar',
          //   position: 'left',
          //   label: 'Contribute guide',
          // },
          {
            href: ROUTES.GITHUB_URL,
            position: 'right',
            className: 'header-github-link',
            'aria-label': 'GitHub repository',
          },
          {
            type: 'search',
            position: 'right',
          },
        ],
      },
      footer: {
        logo: {
          alt: 'Passbolt logo',
          src: 'img/logo.svg',
          width: 180,
          height: 32,
          href: ROUTES.WEBSITE_URL,
        },
        links: footerLinks,
        copyright: `Copyright © ${new Date().getFullYear()} Passbolt S.A. All right reserved.`,
      },
      colorMode: {
        defaultMode: 'dark',
        disableSwitch: true,
        respectPrefersColorScheme: false,
      },
      prism: {
        darkTheme: prismThemes.vsDark,
        additionalLanguages: ['bash', 'php'],
      },
    }),
  themes: [
    [
      require.resolve('@easyops-cn/docusaurus-search-local'),
      {
        hashed: true,
        indexBlog: false,
        docsRouteBasePath: '/',
        language: ['en'],
        highlightSearchTermsOnTargetPage: false,
        explicitSearchResultPath: false,
      }
    ],
  ],
  scripts: [
    {
      src: 'https://consent.cookiebot.com/uc.js',
      defer: true,
      'data-cbid': '900808a8-f178-4994-b2ad-66bf3ccca5f7',
      'data-blockingmode': 'auto',
    },
    {
      src: 'https://plausible.io/js/plausible.js',
      defer: true,
      'data-domain': 'passbolt.com',
    }
  ],
  headTags: [
    {
      tagName: 'script',
      attributes: {
        type: 'text/javascript',
        id: 'cookiebot-tracking-configuration',
      },
      innerHTML: `
        function CookiebotCallback_OnAccept() {
          if (Cookiebot.consent.statistics) {
            enableStatisticsCookies();
          } else {
            disableStatisticsCookies();
          }
        }
        function CookiebotCallback_OnDecline() {
          if (!Cookiebot.consent.statistics) {
            disableStatisticsCookies();
          }
        }
        function enableStatisticsCookies() {
          _paq.push(['setCookieConsentGiven']);
        }
        function disableStatisticsCookies() {
          _paq.push(['forgetCookieConsentGiven']);
        }
      `
    },
    {
      tagName: 'script',
      attributes: {
        type: 'text/javascript',
        id: 'matomo-tag-manager',
      },
      innerHTML: `
        <!-- Matomo Tag Manager -->
        var _mtm = window._mtm = window._mtm || [];
        _mtm.push({'mtm.startTime': (new Date().getTime()), 'event': 'mtm.Start'});
        var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
        g.async=true; g.src='https://cdn.matomo.cloud/passbolt.matomo.cloud/container_C0l5nxM2.js'; s.parentNode.insertBefore(g,s);
        <!-- End Matomo Tag Manager -->
      `
    },
    {
      tagName: 'script',
      attributes: {
        type: 'text/javascript',
        id: 'matomo-analytics',
      },
      innerHTML: `
        <!-- Matomo -->
        var _paq = window._paq = window._paq || [];
        /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
        _paq.push(['trackPageView']);
        _paq.push(['enableLinkTracking']);
        _paq.push(['requireCookieConsent']);
        (function() {
          var u="https://passbolt.matomo.cloud/";
          _paq.push(['setTrackerUrl', u+'matomo.php']);
          _paq.push(['setSiteId', '${process.env?.ENV === 'PRODUCTION' ? 1 : 7}']);
          var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
          g.async=true; g.src='https://cdn.matomo.cloud/passbolt.matomo.cloud/matomo.js'; s.parentNode.insertBefore(g,s);
        })();
        <!-- End Matomo Code -->
      `
    }
  ]
};

module.exports = config;