docusaurus.config.js

// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config

import { themes as prismThemes } from "prism-react-renderer";
import remarkDirective from "remark-directive";
import remarkDocScope from "./src/remark/remark-doc-scope.js";
import rehypeWrapTables from "./src/rehype/rehype-wrap-tables.js";

const buildProduct = process.env.DOC_BUILD_PRODUCT?.trim() || "";
const buildVersion = process.env.DOC_BUILD_VERSION?.trim() || "";
const COPYRIGHT_START_YEAR = 2024;
const currentYear = new Date().getFullYear();
const copyrightYearLabel =
  currentYear > COPYRIGHT_START_YEAR
    ? `${COPYRIGHT_START_YEAR}-${currentYear}`
    : `${COPYRIGHT_START_YEAR}`;

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "RDK DOC",
  // tagline: 'Dinosaurs are cool',
  favicon: "img/logo.png",
  // Set the production url of your site here
  url: "https://developer.d-robotics.cc",
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: "/tros_doc/",

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "D-Robotics", // Usually your GitHub org/user name.
  projectName: "tros_doc", // Usually your repo name.

  // onBrokenLinks: 'throw',

  //add by xgs for build reduce bug
  onBrokenLinks: "warn", // 或 'ignore'
  onBrokenMarkdownLinks: "warn",
  customFields: {
    docBuildScope:
      process.env.DOC_BUILD_PRODUCT?.trim() && process.env.DOC_BUILD_VERSION?.trim()
        ? {
            product: process.env.DOC_BUILD_PRODUCT.trim(),
            version: process.env.DOC_BUILD_VERSION.trim(),
          }
        : null,

    feedbackFloat: {
      enabled: true,
          questionnaireUrl: "https://horizonrobotics.feishu.cn/share/base/form/shrcnLQ9OfYQO03cebdkNfOmkCh",
          questionnaireUrlByLocale: {
            "zh-Hans": "https://horizonrobotics.feishu.cn/share/base/form/shrcnLQ9OfYQO03cebdkNfOmkCh",
            en: "https://horizonrobotics.feishu.cn/share/base/form/shrcnLQ9OfYQO03cebdkNfOmkCh",
      },
      // 站点内路径规则（基于 baseUrl 之后的路径）：
      // - "/*" 匹配全部页面（中英文均生效）
      showOnPathRules: ["/*"],
      hideOnPathRules: [],
    },
},

  //add vy xgs for analysis
  scripts: [
    {
      src: "https://hm.baidu.com/hm.js?24dd63cad43b63889ea6bede5fd1ab9e",
      async: true,
    },
    // Dify Chatbot Configuration
    {
      src: "/tros_doc/js/dify-config.js",
    },
    {
      src: "https://rdk.d-robotics.cc/embed.min.js",
      id: "rJYrxmxmjOkjEx2c",
      defer: true,
    },
  ],

  headTags: [
    {
      tagName: "script",
      attributes: {
        defer: "defer",
        src: "https://cloud.umami.is/script.js",
        "data-website-id": "fbd84605-92b5-43f6-aa3e-4861b62ea8df",
      },
    },
  ],
  // add by xgs for translate
  i18n: {
    defaultLocale: "zh-Hans",
    locales: ["zh-Hans", "en"],
    localeConfigs: {
      en: {
        label: "EN",
      },
      "zh-Hans": {
        label: "CN",
      },
    },
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: "/", // 修改默认文档路径
          sidebarPath: "./sidebars.js",
          showLastUpdateTime: true,
          remarkPlugins: [remarkDirective, remarkDocScope],
          rehypePlugins: [rehypeWrapTables],
        },
        blog: { showReadingTime: true },
        pages: { exclude: ["/imager/**", "**/dl/**"] },
        theme: { customCss: "./src/css/custom.css" },
        sitemap: { lastmod: "date" },
      }),
    ],
  ],
  plugins:  [
    require.resolve("./src/plugins/sidebar-scope-config-plugin"),
    require.resolve("docusaurus-plugin-image-zoom"),
    [
      "docusaurus-plugin-copy-page-button",
      {
        // Match the requested dropdown actions in screenshot.
        enabledActions: ["copy", "view", "claude"],
        // Static .md routes are incompatible with OSS "append /index.html" rules.
        generateMarkdownRoutes: false,
      },
    ],
  ],
  markdown: {
    mermaid: true,
  },
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // Replace with your project's social card
      image: "img/docusaurus-social-card.jpg",
      // ✅ 新增：支持 h2 ~ h5 add by xgs for table of contents
    tableOfContents: {
      minHeadingLevel: 2,
      maxHeadingLevel: 5,
    },
      navbar: {
        title: "D-Robotics",
        logo: {
          alt: "地瓜机器人社区 logo",
          src: "img/logo.png",
          href: "https://d-robotics.cc/", // 修改为文档根路径
        },
        items: [
          {
            type: "custom-DocScopeSelectors",
            position: "left",
          },
          // {
          //   type: "docSidebar",
          //   sidebarId: "tutorialSidebar",
          //   position: "left",
          //   label: "Model Zoo",
          // },
          // add by xgs for S100_doc 2025 年 4 月 21 日 16:34:51 新增S100_doc npm install 去新增插件
          // {
          //   to: '/docs_s/',  // 与routeBasePath保持一致
          //   label: 'RDK S Series',
          //   position: 'left',
          //   // activeBaseRegex: '/docs_s/',
          // },
          // {
          //   type: "docSidebar",
          //   sidebarId: "tutorialSidebar",
          //   docsPluginId: "docs_s",
          //   position: "left",
          //   label: "RDK S100",
          // },

          {
            href: (() => {
              if (process.env.DOCUSAURUS_CURRENT_LOCALE === "en") {
                return "https://developer.d-robotics.cc/en";
              }
              return "https://developer.d-robotics.cc/";
            })(),
            label: "Community",
            position: "left",
          },

          {
            href: "https://github.com/D-Robotics",
            label: "GitHub",
            position: "right",
            className: "navbar-github-link",
          },
          {
            type: "search",
            position: "right",
          },
          // add by xgs for translate show
          {
            type: "localeDropdown",
            position: "right",
            className: "navbar-locale-switch",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "友情链接",
            items: [
              {
                label: "古月居",
                href: "https://www.guyuehome.com/",
              },
            ],
          },
          {
            title: "联系我们",
            items: [
              {
                label: "GitHub",
                href: "https://github.com/D-Robotics",
              },
              {
                label: "BiLiBiLi",
                href: (() => {
                  if (process.env.DOCUSAURUS_CURRENT_LOCALE === "en") {
                    return "https://www.youtube.com/@D-Robotics";
                  }
                  return "https://space.bilibili.com/437998606";
                })(),
              },
            ],
          },
        ],
        copyright: `Copyright © ${copyrightYearLabel} D-Robotics.`,
      },
      prism: {
        theme: prismThemes.github,
        darkTheme: prismThemes.dracula,
      },
      zoom: {
        selector: ".markdown img",
        background: {
          light: "rgb(255, 255, 255)",
          dark: "rgb(50, 50, 50)",
        },
        config: {
          margin: 24,
          scrollOffset: 80,
        },
      },
    }),
  themes: [
    "@docusaurus/theme-mermaid",
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      {
        hashed: true,
        language: ["en", "zh"],
        highlightSearchTermsOnTargetPage: true,
        explicitSearchResultPath: true,
        docsRouteBasePath: ["/", "rdk_s"],
        indexDocs: true,
        indexBlog: false,
        indexPages: false,
        searchResultContextMaxLength: 50,
      },
    ],
  ],
};

export default config;