docusaurus.config.js

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

/* eslint @typescript-eslint/no-var-requires: "off" */

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

const TwitterSvg =
  '<svg style="fill: #1DA1F2; vertical-align: middle;" width="16" height="16" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg>';

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "TigrisDB",
  tagline:
    "ZeroOps globally distributed database for real-time websites and apps",
  url: "https://docs.tigrisdata.com",
  baseUrl: "/",
  favicon: "img/favicon.ico",
  organizationName: "tigrisdata",
  projectName: "tigrisdb-docs",
  onBrokenLinks: "ignore",
  onBrokenMarkdownLinks: "warn",

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: "/",
          sidebarPath: require.resolve("./sidebars.js"),
          editUrl: "https://github.com/tigrisdata/tigrisdb-docs/blob/main",
          showLastUpdateAuthor: true,
          showLastUpdateTime: true,
        },
        blog: {
          routeBasePath: "blog",
          path: "blog",
          postsPerPage: 10,
          editUrl: "https://github.com/tigrisdata/tigrisdb-docs/blob/main",
          blogTitle: "Tigris Data Blog",
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        gtag: {
          trackingID: "G-GW2DNH9EW4",
          anonymizeIP: true,
        },
      }),
    ],
    [
      "docusaurus-protobuffet",
      {
        protobuffet: {
          fileDescriptorsPath: "./fixtures/proto_workspace.json",
          protoDocsPath: "./protodocs",
          sidebarPath: "./generatedSidebarsProtodocs.js",
        },
        docs: {
          sidebarPath: "./sidebarsProtodocs.js",
        },
      },
    ],
    [
      "redocusaurus",
      {
        // Plugin Options for loading OpenAPI files
        specs: [
          {
            spec: "external/tigrisdb-api/server/v1/api_openapi.yaml",
            route: "/apidocs/",
          },
        ],
        // Theme Options for modifying how redoc renders them
        theme: {
          // Change with your site colors
          primaryColor: "#fddc7b",
        },
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: "dark",
        respectPrefersColorScheme: true,
      },
      announcementBar: {
        id: "announcementBar-1", // increment on change
        content: `⭐️ Give us a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/tigrisdata/tigrisdb">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/TigrisData" >Twitter</a> ${TwitterSvg}`,
        backgroundColor: "#5ecbad",
        textColor: "#262b31",
      },
      navbar: {
        hideOnScroll: true,
        title: "TigrisDB",
        logo: {
          alt: "TigrisDB Logo",
          src: "img/logo.svg",
        },
        items: [
          {
            label: "Docs",
            to: "/",
            position: "left",
          },
          {
            label: "API Reference",
            to: "apidocs/",
            position: "left",
          },
          {
            label: "RPC Reference",
            to: "protodocs/server/v1/api.proto",
            activeBasePath: "protodocs",
            position: "left",
          },
          {
            href: "https://join.slack.com/t/tigrisdatacommunity/shared_invite/zt-16fn5ogio-OjxJlgttJIV0ZDywcBItJQ",
            label: "Slack Community",
            position: "right",
          },
          {
            href: "https://github.com/tigrisdata/tigrisdb",
            className: "navbar-item-github",
            position: "right",
          },
          {
            href: "https://twitter.com/TigrisData",
            className: "navbar-item-twitter",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Company",
            items: [
              {
                label: "About",
                to: "/",
              },
              {
                label: "Careers",
                to: "/",
              },
            ],
          },
          {
            title: "Resources",
            items: [
              {
                label: "Docs",
                to: "/",
              },
              {
                label: "API Reference",
                to: "apidocs/",
              },
              {
                label: "RPC Reference",
                to: "protodocs/server/v1/api.proto",
              },
            ],
          },
          {
            title: "Community",
            items: [
              {
                label: "GitHub",
                href: "https://github.com/tigrisdata/tigrisdb",
              },
              {
                label: "Slack",
                href: "https://join.slack.com/t/tigrisdatacommunity/shared_invite/zt-16fn5ogio-OjxJlgttJIV0ZDywcBItJQ",
              },
              {
                label: "Twitter",
                href: "https://twitter.com/TigrisData",
              },
              {
                label: "LinkedIn",
                href: "https://www.linkedin.com/company/tigrisdata/",
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Tigris Data, Inc.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;