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: 'Uptane',
  tagline: 'Securing Software Updates for Automobiles',
  favicon: 'img/favicon.ico',

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

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

  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',
  deploymentBranch: 'gh-pages',
  trailingSlash: false,
  // 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'],
  },

  stylesheets: [
    //Add Font Awesome stylesheets
    '/fonts/font-awesome/fontawesome.css',
    '/fonts/font-awesome/solid.css',
    '/fonts/font-awesome/regular.css',
    '/fonts/font-awesome/brands.css'
  ],

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          lastVersion: "2.1.0",
          versions: {
            current: {
              label: 'Latest (2.1.0)',
              path: "latest",
              banner: "none",
            },
            "2.1.0": {
              label: "2.1.0",
              path: "2.1.0",
            },
            "2.0.0": {
              label: "2.0.0",
            },
            "1.2.0": {
              label: "1.2.0",
            },
            "1.1.0": {
              label: "1.1.0",
            },
            "1.0.0": {
              label: "1.0.0",
            },
          },
        },
        blog: {
          showReadingTime: true,
          path: 'blog', // The directory containing your blog posts
          routeBasePath: 'blog', // The base path for the blog pages
          blogSidebarTitle: 'All posts',
          blogSidebarCount: 'ALL',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        gtag: {
          trackingID: 'G-G856J3S8ZG',
          anonymizeIP: true,
        },
      }),
    ],
  ],
  plugins: [
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'learn-more',
        path: 'learn-more',
        routeBasePath: 'learn-more',
        sidebarPath: './sidebarLearnMore.js',
      },
    ],
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'enhancements',
        path: 'enhancements',
        routeBasePath: 'enhancements',
        sidebarPath: './sidebarEnhancements.js',
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      tableOfContents: {
        minHeadingLevel: 2,
        maxHeadingLevel: 5,
      },
      algolia: {
        appId: "WZ6MBDOHOT",
        apiKey: "426b6390ff8a971f493d017aef9d9e0a",
        indexName: "uptaneio",
        contextualSearch: true,
      },
      navbar: {
        logo: {
          alt: 'Uptane Logo',
          src: '/img/uptane_logo_light.svg',
          srcDark: '/img/uptane_logo_dark.svg'
        },
        items: [
          {
            position: 'left',
            to: 'learn-more/about',
            label: 'About Us',
          },
          {
            type: 'doc',
            docId: 'standard/uptane-standard', label: 'Standard', position: 'left',
          },
          {
            type: 'doc',
            label: 'Best Practices',
            docId: 'deployment/best-practices',
            position: 'left'
          },
          {
            type: 'dropdown',
            label: 'Enhancements',
            position: 'left',
            items: [
              {
                label: 'POUF',
                to: '/enhancements/pouf/pouf-main',
              },
              {
                label: 'PUREs',
                to: '/enhancements/pures/pure1',
              },
            ],
          },
          { to: 'learn-more/getting-started', label: 'Learn More', position: 'left', activeBaseRegex: `/learn-more/`, },
          { to: '/blog', label: 'Blog', position: 'left' },
          {
            to: 'https://github.com/uptane/uptane.github.io',
            label: ' ',
            position: 'right',
            target: '_blank',
            className: 'fab fa-lg fa-github',
          },
          {
            type: "docsVersionDropdown",
            position: "right",
            dropdownActiveClassDisabled: true,
            dropdownItemsAfter: [
              {
                to: "/docs/latest/all-versions",
                label: "All versions",
              },
            ],
          },
        ],
      },
      footer: {
        style: 'light',
        links: [
          {
            title: 'Docs',
            items: [
              {
                label: 'Getting Started',
                to: '/learn-more/getting-started',
              },
              {
                label: "Contributor's Guide",
                to: '/learn-more/participate',
              },
              {
                label: "About Us",
                to: '/learn-more/about',
              },
            ],
          },
          {
            title: 'Community',
            items: [
              // {
              //   label: 'Stack Overflow',
              //   href: 'https://stackoverflow.com/questions/tagged/uptane',
              // },
              {
                label: 'Discord',
                href: 'https://discord.com/invite/uWyT6gDCqx',
              },
              // {
              //   label: 'Twitter',
              //   href: 'https://twitter.com/UptaneSecurity',
              // },
              {
                label: 'LinkedIn',
                href: 'https://linkedin.com/company/uptane',
              },
              {
                label: 'Youtube',
                href: 'https://www.youtube.com/@Uptane',
              },
            ],
          },
          {
            title: 'More',
            items: [
              {
                label: 'GitHub',
                href: 'https://github.com/uptane',
              },
              {
                label: "Blog",
                to: '/blog',
              }
            ],
          },
        ],
        copyright: `© ${new Date().getFullYear()} Uptane | All Rights Reserved`,
      },
      prism: {
        theme: lightTheme,
        darkTheme: darkTheme,
        additionalLanguages: ['bash', 'diff', 'json'],
      },
      metadata: [{ name: 'keywords', content: 'uptane, secure software update framework for automobiles' }],
    }),
};

module.exports = config;