docusaurus.config.base.js

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

const { grafanaPrismTheme } = require('./src/theme/prism.ts');

// /** @type {import('@docusaurus/types').Config} */
const baseConfig = {
  title: 'Grafana Labs Design System',
  tagline: 'Design Systems are cool',
  url: 'https://grafana.com/',
  baseUrl: 'developers/saga/',
  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/logo.png',
  staticDirectories: ['static'],
  trailingSlash: true,

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'Grafana', // Usually your GitHub org/user name.
  projectName: 'design-system', // 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} */
      ({
        docs: {
          path: 'docs',
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
          editUrl: 'https://github.com/grafana/design-system/blob/main/',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
        blog: false, // disabled for now but maybe we can have a design system blog later :)
        pages: {
          path: 'pages',
        },
      }),
    ],
  ],

  plugins: [
    customPostCssPlugin, // PostCSS plugin function registration
  ],

  themes: ['@docusaurus/theme-live-codeblock'],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // announcementBar: {
      //   id: 'welcome',
      //   content:
      //     'Welcome to our design system! Learn more <a target="_blank" rel="noopener noreferrer" href="#">here</a>',
      //   backgroundColor: '#fafbfc',
      //   textColor: '#091E42',
      //   isCloseable: true,
      // },
      colorMode: {
        defaultMode: 'dark',
        disableSwitch: true,
      },
      prism: {
        theme: grafanaPrismTheme,
      },
      navbar: {
        logo: {
          alt: 'Design System logo',
          href: 'about/overview',
          src: '/img/logo_with_text.png',
        },
        items: [
          {
            href: 'https://github.com/grafana/design-system',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
    }),
  scripts: ['https://klesun-misc.github.io/TypeScript/lib/typescriptServices.js'],
};

/** @return {import('@docusaurus/types').Plugin} */
function customPostCssPlugin() {
  return {
    name: 'custom-postcss',
    configurePostCss(options) {
      // Append new PostCSS plugins here.
      options.plugins.push(require('postcss-preset-env')); // allow newest CSS syntax
      return options;
    },
  };
}

module.exports = baseConfig;