docusaurus.config.ts

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
import type { Config } from '@docusaurus/types';
import { themes } from 'prism-react-renderer';

const navIcon = (name: string, size = 24) =>
  `<svg aria-hidden="true" width="${size}px" height="${size}px" style="fill: currentcolor; vertical-align: -0.5em;"><use xlink:href="#icon-${name}"></use></svg>`;
const lightCodeTheme = themes.oneLight;
const darkCodeTheme = themes.oneDark;
const config: Config = {
  title: 'Alova.JS',
  tagline:
    'alova is perfectly compatible with your favorite HTTP clients and UI frameworks, accelerates business logic for both client and server apps, while making API documentation and and code interactive with each other. delivering ultimate efficiency in APIs integration.',
  url: 'https://alova.js.org',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'throw',
  favicon: 'img/favicon.ico',

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'alovajs', // Usually your GitHub org/user name.
  projectName: 'alova', // 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', 'zh-CN'],
    localeConfigs: {
      en: {
        htmlLang: 'en-GB'
      }
    }
  },
  scripts: ['/iconfont/iconfont.js'],
  presets: [
    [
      'classic',
      {
        docs: {
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: 'https://github.com/alovajs/alovajs.github.io/blob/main/',
          lastVersion: 'current',
          versions: {
            current: {
              label: 'v3'
            }
          }
        },
        // disable blog
        blog: false,
        theme: {
          customCss: require.resolve('./src/css/custom.scss')
        },
        googleTagManager: {
          containerId: 'GTM-539X2N2M'
        }
      }
    ]
  ],

  stylesheets: [
    'https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;600&family=JetBrains+Mono:wght@400;500;600&family=Share+Tech:wght@400;500;600&display=swap'
  ],
  themeConfig: {
    image: '/img/card_image.jpg',
    metadata: [{ name: 'twitter:site', content: '@alovajs' }],
    navbar: {
      title: '',
      logo: {
        alt: 'Alova',
        src: 'img/logo-text.svg',
        srcDark: 'img/logo-text-dark.svg'
      },
      items: [
        {
          type: 'dropdown',
          label: 'Docs',
          position: 'left',
          items: [
            {
              label: 'Getting Started',
              to: 'tutorial/getting-started/introduce'
            },
            {
              label: 'Request Adapter',
              to: 'resource/request-adapter'
            },
            {
              label: 'Storage Adapter',
              to: 'resource/storage-adapter'
            },
            {
              label: 'UI Frameworks',
              to: 'category/framework'
            },
            {
              label: 'Error Reference',
              to: 'error'
            }
          ]
        },
        {
          to: 'examples',
          position: 'left',
          label: 'Example'
        },
        {
          to: 'api/alova',
          position: 'left',
          label: 'API'
        },
        {
          type: 'dropdown',
          label: 'About',
          position: 'left',
          items: [
            {
              label: 'Request Scene Model',
              to: 'about/RSM'
            },
            {
              label: 'Comparison',
              to: 'about/comparison'
            },
            {
              label: 'Releases',
              to: 'https://github.com/alovajs/alova/releases'
            },
            {
              label: 'FAQs',
              to: 'about/faqs'
            }
          ]
        },
        {
          type: 'dropdown',
          label: 'Contributing',
          position: 'left',
          items: [
            {
              label: 'Contributing Guidelines',
              to: 'contributing/overview'
            },
            {
              label: 'Become core member',
              to: 'contributing/become-core-member'
            },
            {
              label: 'Developing Guidelines',
              to: 'contributing/developing-guidelines'
            },
            {
              label: 'Code of conduct',
              to: 'contributing/code-of-conduct'
            }
          ]
        },
        {
          to: 'showcase',
          position: 'left',
          label: 'Showcase'
        },
        {
          type: 'search',
          className: 'doc-search',
          position: 'right'
        },
        {
          type: 'docsVersionDropdown',
          position: 'right',
          dropdownActiveClassDisabled: true
        },
        {
          type: 'localeDropdown',
          position: 'right'
        },
        {
          href: 'https://github.com/alovajs/alova',
          position: 'right',
          html: navIcon('github')
        },
        {
          href: '/img/wechat_qrcode.jpg',
          target: '_blank',
          position: 'right',
          html: navIcon('wechat')
        },
        {
          href: 'https://x.com/alovajs',
          position: 'right',
          html: navIcon('x', 20)
        },
        {
          href: 'https://discord.gg/S47QGJgkVb',
          position: 'right',
          html: navIcon('discord1', 22)
        }
      ]
    },
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: true
    },
    announcementBar: {
      id: 'support_us',
      content: `<span class="announcement">⭐️If you also like alova, 
      <a
        href="https://github.com/alovajs/alova"
        target="_blank">
        star it on GitHub!
      </a>⭐️</span>`,
      backgroundColor: 'rgba(var(--ifm-color-primary-rgb), 0.05)'
      // textColor: '#fff'
    },
    footer: {
      style: 'light',
      logo: {
        alt: 'alova.js',
        src: 'img/logo.svg',
        href: 'https://github.com/alovajs/alova',
        width: 160,
        height: 51
      },

      links: [
        {
          title: 'Document',
          items: [
            {
              label: 'Docs',
              to: 'tutorial/getting-started/introduce'
            },
            {
              label: 'Example',
              to: 'examples'
            },
            {
              label: 'API',
              to: 'api/alova'
            },
            {
              label: 'Contributing',
              to: 'contributing/overview'
            }
          ]
        },
        {
          title: 'Resource',
          items: [
            {
              label: 'Request Adapter',
              to: 'resource/request-adapter'
            },
            {
              label: 'Storage Adapter',
              to: 'resource/storage-adapter'
            },
            {
              label: 'Framework Support',
              to: 'category/framework'
            }
          ]
        },
        {
          title: 'Community',
          items: [
            {
              label: 'Discord',
              to: 'https://discord.gg/S47QGJgkVb'
            },
            {
              label: 'X',
              to: 'https://x.com/alovajs'
            },
            {
              html: '<a href="/img/wechat_qrcode.jpg" target="_blank" class="footer__link-item" rel="noreferrer noopener">Wechat Group</a>'
            }
          ]
        },
        {
          title: 'More',
          items: [
            {
              label: 'GitHub',
              to: 'https://github.com/alovajs/alova'
            },
            {
              label: 'Issues',
              to: 'https://github.com/alovajs/alova/issues'
            },
            {
              label: 'Pull request',
              to: 'https://github.com/alovajs/alova/pulls'
            }
          ]
        }
      ],
      copyright: `Copyright © ${new Date().getFullYear()} alova.js Team and contributors`
    },
    prism: {
      theme: lightCodeTheme,
      darkTheme: darkCodeTheme,

      // https://github.com/facebook/docusaurus/discussions/9506#discussioncomment-7506183
      additionalLanguages: ['javascript', 'bash']
    },

    algolia: {
      // The application ID provided by Algolia
      appId: 'LGEFHNJ1SI',

      // Public API key: it is safe to commit it
      apiKey: '4c4f6078174a5ae66234de817e75e0a8',

      indexName: 'alova_website',

      // 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: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
      replaceSearchResultPathname: {
        from: '/docs/', // or as RegExp: /\/docs\//
        to: '/'
      },

      // Optional: Algolia search parameters
      searchParameters: {},

      // Optional: path for search page that enabled by default (`false` to disable it)
      searchPagePath: 'search'
    }
  },

  markdown: {
    mermaid: true
  },
  // 主题
  themes: ['@docusaurus/theme-mermaid'],

  // 插件
  plugins: [
    'docusaurus-plugin-sass',
    [
      './plugin/baiduStatistics',
      {
        id: '5afa4c96fca09cb386951b736ee31e56'
      }
    ],
    './plugin/webpack'
  ]
};

export default config;