docusaurus.config.js

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

const path = require('path');
const vars = require('./vars');

const lightCodeTheme = require('prism-react-renderer').themes.github;
const darkCodeTheme = require('prism-react-renderer').themes.oceanicNext;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Next Hat Docs',
  tagline: '_Our code is open_',
  url: 'https://docs.next-hat.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/logo.webp',
  trailingSlash: false,
  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'next-hat', // Usually your GitHub org/user name.
  projectName: 'documentation', // Usually your repo name.

  // 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'],
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        blog: {
          blogTitle: 'Next Hat blog',
          blogDescription: 'Latest new about Next Hat technologies',
          postsPerPage: 'ALL',
        },
        docs: {
          path: 'docs',
          routeBasePath: '/',
          breadcrumbs: true,
          sidebarPath: require.resolve('./sidebars.js'),
          showLastUpdateTime: true,
          editUrl:
            'https://github.com/next-hat/documentation/tree/master/',
          async sidebarItemsGenerator({
              defaultSidebarItemsGenerator,
              ...args
            }) {
              let sidebarItems = await defaultSidebarItemsGenerator(args)
              sidebarItems = sidebarItems.map((item) => {
                // @ts-ignore
                item.items = item?.items?.map((subItem) => {
                  if (subItem.type === 'category' && subItem.label === 'Daemon') {
                    /// Add version reference to the sidebar for the daemon
                    subItem.items.push({
                      type: 'link',
                      label: `v${vars.nanoclMajorVersion} reference (latest)`,
                      href: `/references/nanocl/daemon/v${vars.nanoclMajorVersion}`,
                    })
                  }
                  return subItem;
                }) || [];
                return item;
              });

              return sidebarItems.filter(
                (item) =>
                  // @ts-ignore
                  // This makes sure that the landing pages are not duplicated in the sidebars
                  item.id !== 'guides/summary' && item.id !== 'manuals/summary' && item.id !== 'references/summary'
              )
          },
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        gtag: {
          trackingID: 'G-L5PJ2B6W8P',
          anonymizeIP: false,
        },
        googleAnalytics: {
          trackingID: 'G-L5PJ2B6W8P',
          anonymizeIP: false,
        },
      }),
    ],
    [
      'redocusaurus',
      {
        debug: Boolean(process.env.DEBUG || process.env.CI),
        config: path.join(__dirname, 'redocly.yaml'),
        specs: [{
          id: 'nanocld-latest',
          spec: `static/specs/nanocld/${vars.nanoclMajorVersion}.yaml`,
        }],
        // See https://redocly.com/docs/api-reference-docs/configuration/theming/
        theme: {
          /**
           * Highlight color for docs
           */
          primaryColor: '#ff9800',
        },
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        {
          name: 'keywords',
          content: 'Next Hat, next, hat, next-hat, next hat, next, hat, documentation, doc, next hat doc, next doc, hat doc, nanocl, docker, container, cluster, replication, hight avaibility, daemon, vpn, ipsec, ikev2, cloud, cloud-hybride, hybrid, devops, blazing fast, cicd, qemu, vm, virtual machine',
        },
      ],
      colorMode: {
        defaultMode: 'light',
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      navbar: {
        title: 'Next Hat Docs',
        logo: {
          alt: 'Next Hat logo',
          src: 'img/logo.webp',
          width: '32',
          height: '32',
        },
        items: [
          {to: 'blog', label: 'Blog', position: 'left'},
          {
            type: 'doc',
            position: 'left',
            docId: 'guides/summary',
            label: 'Guides',
          },
          {
            type: 'doc',
            position: 'left',
            docId: 'manuals/summary',
            label: 'Manuals',
          },
          {
            type: 'doc',
            position: 'left',
            docId: 'references/summary',
            label: 'References',
          },
        ],
      },
      footer: {
        links: [
          {
            title: 'Community',
            items: [
              {
                label: 'Discord',
                href: 'https://discord.gg/WV4Aac8uZg',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'GitHub',
                href: 'https://github.com/next-hat',
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Next Hat and Contributors.`,
      },
      prism: {
        additionalLanguages: ['nginx', 'yaml', 'rust', 'json', 'toml', 'docker'],
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;