docusaurus.config.ts

import type * as Preset from "@docusaurus/preset-classic";
import type { Config } from "@docusaurus/types";
import type { PluginOptions as SearchLocalPluginOptions } from "@easyops-cn/docusaurus-search-local";
import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
import { themes as prismThemes } from "prism-react-renderer";
import rehypeKatex from "rehype-katex";
import remarkMath from "remark-math";
import { EnumChangefreq } from "sitemap";

const siteUrl = new URL(process.env.SITE_URL || "https://datadata-team.github.io/datadata-docs");

const config: Config = {
  title: "DataData Docs",
  tagline: "DataData is a platform for data analysis and visualization",
  favicon: "img/favicon.ico",
  future: {
    v4: true,
  },
  url: siteUrl.origin,
  baseUrl: `${siteUrl.pathname}/`,
  organizationName: "datadata-team",
  projectName: "datadata-docs",
  onBrokenLinks: "warn",
  i18n: {
    defaultLocale: "zh-Hans",
    locales: ["en", "zh-Hans"],
  },
  themes: [
    "@docusaurus/theme-mermaid",
    "docusaurus-theme-openapi-docs",
    [
      "@easyops-cn/docusaurus-search-local",
      {
        hashed: true,
        indexDocs: true,
        indexBlog: true,
        indexPages: true,
      } satisfies SearchLocalPluginOptions,
    ],
  ],
  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          remarkPlugins: [remarkMath],
          rehypePlugins: [rehypeKatex],
          docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi
        },
        blog: {
          showReadingTime: true,
          feedOptions: {
            type: ["rss", "atom"],
            xslt: true,
          },
          onInlineTags: "warn",
          onInlineAuthors: "warn",
          onUntruncatedBlogPosts: "warn",
        },
        theme: {
          customCss: [
            "./src/css/custom.css", //
            "./src/css/openapi.css", //
          ],
        },
        sitemap: {
          priority: 0.5,
          filename: "sitemap.xml",
          changefreq: EnumChangefreq.WEEKLY,
        },
      } satisfies Preset.Options,
    ],
  ],
  plugins: [
    [
      // https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects
      "@docusaurus/plugin-client-redirects",
      {},
    ],
    [
      // https://github.com/PaloAltoNetworks/docusaurus-openapi-docs
      "docusaurus-plugin-openapi-docs",
      {
        id: "api",
        docsPluginId: "classic",
        config: {
          openapi: {
            specPath: "assets/swagger.yaml",
            outputDir: "docs/api/openapi",
            // showSchemas: false,
            // schemaTemplate: "templates/schema.mustache",
            hideSendButton: true,
            maskCredentials: true,
            sidebarOptions: {
              groupPathsBy: "tag",
              // categoryLinkSource: "tag",
            },
          } satisfies OpenApiPlugin.Options,
        },
      },
    ],
  ],
  markdown: {
    mermaid: true,
  },
  themeConfig: {
    image: "img/docusaurus-social-card.jpg",
    colorMode: {
      respectPrefersColorScheme: true,
    },
    // https://docusaurus.io/docs/api/themes/configuration#navbar
    navbar: {
      logo: {
        alt: "DataData Logo",
        src: "img/logo.svg",
        srcDark: "img/logo-dark.svg",
      },
      items: [
        {
          type: "docSidebar",
          label: "用户指南",
          position: "left",
          sidebarId: "guidesSidebar",
        },
        {
          type: "docSidebar",
          label: "API",
          position: "left",
          sidebarId: "apiSidebar",
        },
        // {
        //   to: "/blog",
        //   label: "博客",
        //   position: "left",
        // },
        {
          type: "search",
          position: "right",
        },
        {
          type: "localeDropdown",
          position: "right",
        },
        {
          label: "返回主站",
          href: "https://www.datadata.com",
          position: "right",
        },
      ],
      hideOnScroll: true,
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "合作伙伴",
          items: [
            {
              label: "发明者量化",
              href: "https://www.fmz.com",
            },
          ],
        },
        {
          title: "资源",
          items: [
            {
              label: "AI Skills",
              href: "https://www.skills.sh/datadata-team/datadata-skills",
            },
          ],
        },
        {
          title: "链接",
          items: [
            {
              to: "/",
              label: "首页",
            },
            {
              to: "/docs/guides/intro",
              label: "用户指南",
            },
            {
              to: "/docs/api/api-key",
              label: "API",
            },
            {
              to: "/blog",
              label: "博客",
            },
          ],
        },
        {
          title: "More",
          items: [
            {
              label: "Datadata",
              href: "https://www.datadata.com",
            },
            {
              label: "Datadata Studio",
              href: "https://www.datadata.com/studio",
            },
            {
              label: "GitHub",
              href: "https://github.com/datadata-team",
            },
          ],
        },
      ],
      copyright: `Copyright © 2023-${new Date().getFullYear()} Datadata. Built with <a href="https://docusaurus.io/" target="_blank" rel="noopener noreferrer">Docusaurus</a>.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
  } satisfies Preset.ThemeConfig,
  stylesheets: [
    {
      href: "https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css",
      type: "text/css",
      integrity: "sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
      crossorigin: "anonymous",
    },
  ],
};

export default config;