docusaurus.config.js

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

const myTheme = require("./prism-theme");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "RizzUI",
  tagline:
    "A Modern and Minimal React UI Library built with TailwindCSS. Designed to provide you with a simple and intuitive set of UI components that are easy to use, customize and integrate into your React application.",
  favicon: "img/rizz-favicon.svg",

  // Set the production url of your site here
  url: "https://ui.xlox.in/",
  // 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: "trexjs", // Usually your GitHub org/user name.
  projectName: "ui", // Usually your repo name.

  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",

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

  plugins: [
    async function myPlugin(context, options) {
      return {
        name: "docusaurus-tailwindcss",
        configurePostCss(postcssOptions) {
          // Appends TailwindCSS and AutoPrefixer.
          postcssOptions.plugins.push(require("tailwindcss"));
          postcssOptions.plugins.push(require("autoprefixer"));
          return postcssOptions;
        },
      };
    },
  ],

  themes: [
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      {
        hashed: true,
        highlightSearchTermsOnTargetPage: true,
        explicitSearchResultPath: true,
      },
    ],
  ],

  presets: [
    [
      "@docusaurus/preset-classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          editUrl: "https://github.com/rizzui/rizzui/apps/docs",
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // Replace with your project's social card
      image: "img/rizz-social-card.jpg",
      fonts: {
        myFont: ["Geist", "sans-serif"],
        myOtherFont: ["-apple-system", "system-ui", "sans-serif"],
      },
      navbar: {
        // hideOnScroll: true,
        logo: {
          alt: "RizzUI",
          src: "img/rizz-logo.svg",
        },
        items: [
          {
            to: "docs/guide/getting-started",
            position: "left",
            label: "Documentation",
          },
          {
            to: "docs/buttons/action-icon",
            position: "left",
            label: "Components",
          },
          {
            href: "https://github.com/rizzui/rizzui",
            position: "right",
            className: "header-github-link order-3 ml-3 -mr-3",
            "aria-label": "GitHub",
          },
        ],
      },
      colorMode: {
        defaultMode: "light",
        respectPrefersColorScheme: true,
      },
      prism: {
        theme: myTheme,
        darkTheme: myTheme,
      },
    }),
};

module.exports = config;