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';

// Code themes: keep the token colours, swap the background for the design
// tokens in src/css/custom.css (--tc-surface) so code blocks sit on the
// same warm neutral as the rest of the site. See DESIGN.md.
const codeTheme = {
  ...prismThemes.github,
  plain: {...prismThemes.github.plain, backgroundColor: '#F6F6F3'},
};
const codeThemeDark = {
  ...prismThemes.oneDark,
  plain: {
    ...prismThemes.oneDark.plain,
    backgroundColor: '#292D33',
    textShadow: 'none',
  },
};

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Typecho Docs',
  tagline: 'Typecho Docs',
  favicon: 'img/favicon.ico',

  // Set the production url of your site here
  url: 'https://docs.typecho.org',
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: '/',

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'typecho', // Usually your GitHub org/user name.
  projectName: 'docs', // Usually your repo name.

  onBrokenLinks: 'throw',
  onBrokenAnchors: 'throw',

  markdown: {
    hooks: {
      onBrokenMarkdownLinks: 'throw',
    },
  },

  // Even if you don't use internationalization, 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: 'zh-Hans',
    locales: ['zh-Hans', 'en'],
    localeConfigs: {
      'zh-Hans': {
        label: '中文',
        htmlLang: 'zh-Hans',
      },
      en: {
        label: 'English',
        htmlLang: 'en',
      },
    },
  },

  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: './sidebars.js',
          routeBasePath: '/',
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl:
            'https://github.com/typecho/docs/tree/main',
          editLocalizedFiles: true,
          versions: {
            current: {
              label: '1.3',
              banner: 'none',
            },
          },
          // develop/index is listed explicitly at the top of devSidebar,
          // so drop it from the autogenerated items to avoid a duplicate.
          async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
            const items = await defaultSidebarItemsGenerator(args);
            return items.filter(
              (item) => !(item.type === 'doc' && item.id === 'develop/index'),
            );
          },
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      }),
    ],
  ],

  themes: [
    [
      '@easyops-cn/docusaurus-search-local',
      /** @type {import('@easyops-cn/docusaurus-search-local').PluginOptions} */
      ({
        hashed: true,
        language: ['en', 'zh'],
        docsRouteBasePath: '/',
        indexBlog: false,
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // Replace with your project's social card
      image: 'img/docusaurus-social-card.jpg',
      navbar: {
        title: 'Docs',
        logo: {
          alt: 'Typecho Logo',
          src: 'img/typecho-logo.svg',
        },
        items: [
          {
            type: 'docSidebar',
            sidebarId: 'guideSidebar',
            label: '使用指南',
            position: 'left',
          },
          {
            type: 'docSidebar',
            sidebarId: 'devSidebar',
            label: '开发文档',
            position: 'left',
          },
          {
            type: 'docsVersion',
            position: 'right',
            className: 'navbar-version',
          },
          {
            type: 'search',
            position: 'right',
          },
          {
            type: 'localeDropdown',
            position: 'right',
          },
          {
            href: 'https://typecho.org',
            label: 'Home',
            position: 'right',
          },
          {
            href: 'https://github.com/typecho/typecho',
            label: 'GitHub',
            position: 'right',
          },
        ],
      },
      footer: {
        style: 'light',
        copyright: `© ${new Date().getFullYear()} <a href="https://typecho.org">Typecho</a>`,
      },
      prism: {
        theme: codeTheme,
        darkTheme: codeThemeDark,
        additionalLanguages: ['apacheconf', 'nginx', 'php', 'bash'],
      },
    }),
};

export default config;