githubmirror/strapi

docs/docusaurus.config.js
138 строк4 KB
Ben Irvin
chore: upgrade contributor docs dependencies (#26073)
27 апр 2026, 18:57
27 апр 2026, 18:57416f2f1
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const path = require('path');
const {
  themes: { github: lightCodeTheme, dracula: darkCodeTheme },
} = require('prism-react-renderer');

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: 'Doc',
  tagline: 'Dinosaurs are cool',
  url: 'https://contributor.strapi.io',
  baseUrl: '/',
  onBrokenLinks: 'warn',
  favicon: 'img/favicon.png',
  organizationName: 'strapi',
  projectName: 'strapi',
  trailingSlash: false,
  themes: ['@docusaurus/theme-mermaid'],

  // 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'],
  },
  markdown: {
    mermaid: true,
    hooks: {
      onBrokenMarkdownLinks: 'warn',
    },
  },
  plugins: [
    () => ({
      name: 'resolve-react',
      configureWebpack() {
        return {
          resolve: {
            alias: {
              react: path.resolve(__dirname, './node_modules/react'),
            },
          },
        };
      },
    }),
    [
      'docusaurus-plugin-typedoc',
      {
        entryPoints: ['../packages/core/strapi/src/admin.ts'],
        tsconfig: '../packages/core/strapi/tsconfig.build.json',
        // `readme: 'none'` uses a single project page (no separate index). Together with
        // `entryDocument: 'modules.md'` this avoids generating `index.md` (invalid MDX: bare `<br>` tags).
        // Do not set `entryDocument: null` — it becomes an empty URL and TypeDoc tries to write
        // to the output directory (EISDIR: "Could not write .../exports").
        readme: 'none',
        entryDocument: 'modules.md',
        // Plugin output is under the docs content root (`site/docs/`); use `exports`, not `docs/exports`.
        out: 'exports',
        watch: process.env.TYPEDOC_WATCH,
      },
    ],
    [
      '@cmfcmf/docusaurus-search-local',
      {
        indexBlog: false,
      },
    ],
  ],
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      {
        docs: {
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
          editUrl: 'https://github.com/strapi/strapi/tree/main/docs/',
          remarkPlugins: [require('./remark-design-system-links')],
        },
        blog: false,
      },
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    {
      navbar: {
        title: 'Contributor documentation',
        hideOnScroll: true,
        logo: {
          alt: 'Doc',
          src: 'img/logo.svg',
          srcDark: 'img/logo_dark.svg',
          width: 100,
        },
        items: [
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'guides',
            label: 'Guides',
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'docs',
            label: 'Docs',
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'api',
            label: 'API Reference',
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'exports',
            label: 'Exports',
          },
          {
            type: 'docSidebar',
            position: 'left',
            sidebarId: 'rfcs',
            label: 'RFCs',
          },
        ],
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    },
};

module.exports = config;