docusaurus.config.js

/* eslint-disable @typescript-eslint/no-var-requires */
/* eslint-disable no-undef */
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Lyra✨",
  tagline: "An immutable, edge, full-text search engine",
  url: "https://nearform.github.io",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "/img/lyra.svg",
  deploymentBranch: "gh-pages",

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "nearform", // Usually your GitHub org/user name.
  projectName: "lyra", // 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: {
          sidebarPath: "./sidebars.js",
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: "https://github.com/nearform/lyra/edit/main/packages/docs/",
        },
        blog: {
          showReadingTime: true,
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: "https://github.com/nearform/lyra/edit/main/packages/docs/",
        },
        theme: {
          customCss: "./src/css/custom.css",
        },
      }),
    ],
  ],
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        logo: {
          alt: "Lyra Logo",
          src: "/img/lyra.svg",
        },
        items: [
          {
            type: "doc",
            docId: "introduction/getting-started",
            position: "left",
            label: "Getting Started",
          },
          {
            href: "/demo",
            position: "left",
            label: "Live Demo",
            "aria-label": "Live Demo",
          },
          {
            href: "https://github.com/nearform/lyra",
            position: "right",
            className: "header-github-link",
            "aria-label": "Lyra on GitHub",
          },
        ],
      },
      metadata: [
        {
          name: "og:image",
          content: "https://nearform.github.io/lyra/img/ogimg.png",
        },
        {
          name: "og:title",
          content: "Lyra, a fast, in-memory, typo-tolerant, full-text search engine written in TypeScript.",
        },
      ],
      // algolia: {
      //   appId: "lyra",
      //   contextualSearch: true,
      // },
      footer: {
        style: "light",
        links: [
          {
            title: "Docs",
            items: [
              {
                label: "Getting Started",
                to: "/docs/introduction/getting-started",
              },
            ],
          },
          {
            title: "More",
            items: [
              {
                label: "GitHub",
                href: "https://github.com/nearform/lyra",
              },
            ],
          },
        ],
        logo: {
          alt: "Lyra Logo",
          src: "/img/lyra.svg",
        },
        copyright: `Copyright © ${new Date().getFullYear()}\n Made by NearForm with ❤️`,
      },
      colorMode: {
        defaultMode: "dark",
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;