docusaurus.config.js

// @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");
const math = require("remark-math");
const katex = require("rehype-katex");
const mathjax = require("rehype-mathjax");
const sectionPrefix = require("./src/remark/section-prefix");

/** @type {import('@docusaurus/types').Config} */
const config = {
  markdown: {
    mermaid: true,
  },
  themes: [
    "@docusaurus/theme-mermaid",
    // [
    //   // @ts-ignore
    //   require.resolve("@easyops-cn/docusaurus-search-local"),
    //   /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
    //   // @ts-ignore
    //   ({
    //     // ... Your options.
    //     // `hashed` is recommended as long-term-cache of index file is possible.
    //     hashed: true,
    //     // For Docs using Chinese, The `language` is recommended to set to:
    //     // ```
    //     // language: ["en", "zh"],
    //     // ```
    //   }),
    // ],
  ],
  title: "CrossCopy",
  tagline: "Cross-platform clipboard manager",
  url: "https://crosscopy.io",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon_package/favicon.ico",

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "CrossCopy", // Usually your GitHub org/user name.
  projectName: "CrossCopy", // 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} */
      {
        googleAnalytics: {
          trackingID: "G-CMJZGFWKZ1",
        },
        gtag: {
          trackingID: "G-CMJZGFWKZ1",
        },
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: "https://github.com/CrossCopy/crosscopy-doc/edit/develop/",
          remarkPlugins: [math, sectionPrefix],
          rehypePlugins: [katex],
        },
        blog: {
          showReadingTime: true,
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: "https://github.com/CrossCopy/crosscopy-doc/edit/develop/",
          remarkPlugins: [math],
          rehypePlugins: [katex],
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      },
    ],
  ],

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

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      announcementBar: {
        id: "pre-alpha-warning",
        content:
          "CrossCopy is still in alpha stage and is planned to be published by January 2023. Documentation is still under development. If you want to use this app, please subscribe to updates.",
        isCloseable: true,
      },
      algolia: {
        // The application ID provided by Algolia
        appId: 'BCXHBQCAW3',
  
        // Public API key: it is safe to commit it
        apiKey: 'c6060582d19e25400658473d4f15b7fc',
  
        indexName: 'crosscopy',
  
        // Optional: see doc section below
        contextualSearch: true,
  
        // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
        // externalUrlRegex: 'external\\.com|domain\\.com',
  
        // Optional: Algolia search parameters
        searchParameters: {},
  
        // Optional: path for search page that enabled by default (`false` to disable it)
        searchPagePath: 'search',
  
        //... other Algolia params
      },  
      metadata: [
        {
          name: "keywords",
          content:
            "crosscopy, clipboard, cloud, cross-platform, sync, realtime, open source, free",
        },
      ],
      navbar: {
        title: "CrossCopy",
        logo: {
          alt: "My Site Logo",
          src: "img/CrossCopy-Logo.svg",
        },
        items: [
          {
            type: "doc",
            docId: "intro",
            position: "left",
            label: "Docs",
          },
          { to: "/blog", label: "Blog", position: "left" },
          {
            href: "https://github.com/CrossCopy/crosscopy-doc",
            position: "right",
            className: "header-github-link",
            "aria-label": "GitHub repository",
          },
          {
            href: "https://twitter.com/crosscopyio",
            className: "header-twitter-link",
            position: "right",
          },
          {
            href: "https://discord.gg/HRW99gex9z",
            className: "header-discord-link",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Docs",
            items: [
              {
                label: "Intro",
                to: "/docs/intro",
              },
              {
                label: "Blog",
                to: "/blog",
              },
            ],
          },
          {
            title: "Community",
            items: [
              // {
              //   label: 'Stack Overflow',
              //   href: 'https://stackoverflow.com/questions/tagged/docusaurus',
              // },
              {
                label: "Discord",
                href: "https://discord.gg/HRW99gex9z",
              },
              {
                label: "Twitter",
                href: "https://twitter.com/crosscopyio",
              },
              {
                label: "GitHub",
                href: "https://github.com/CrossCopy/crosscopy-doc",
              },
            ],
          },
          {
            title: "More",
            items: [
              {
                label: "Author",
                href: "https://huakunshen.com",
              },
              {
                label: "Contact Author",
                href: "mailto:huakun.shen@crosscopy.io",
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Huakun Shen. Built with Docusaurus.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;