close

    Расширение сборки

    Rsbuild

    Rspress собирает документацию с помощью Rsbuild.

    Настройка Rsbuild

    Rsbuild предоставляет богатый набор параметров сборки. Настроить их можно через опцию builderConfig. Например, поменять папку вывода на doc_dist:

    rspress.config.ts
    import { defineConfig } from '@rspress/core';

export default defineConfig({
  builderConfig: {
    output: {
      distPath: {
        root: 'doc_dist',
      },
    },
  },
});

    Rspress также предоставляет конфигурацию builderConfig.plugins, с помощью которой можно подключать плагины Rsbuild. Вы можете использовать обширную экосистему плагинов Rsbuild, чтобы расширить и улучшить возможности сборки.

    Например, добавить Google Analytics через плагин rsbuild-plugin-google-analytics:

    rspress.config.ts
    import { defineConfig } from '@rspress/core';
import { pluginGoogleAnalytics } from 'rsbuild-plugin-google-analytics';

export default defineConfig({
  builderConfig: {
    plugins: [
      pluginGoogleAnalytics({
        // замените на свой Google tag ID
        id: 'G-xxxxxxxxxx',
      }),
    ],
  },
});
    Совет

    Подробно о всех доступных опциях конфигурации можно узнать в официальной документации Rsbuild - Config.

    Настройка Rspack

    Настроить Rspack можно через опцию tools.rspack, которую предоставляет сам Rsbuild:

    rspress.config.ts
    import { defineConfig } from '@rspress/core';

export default defineConfig({
  builderConfig: {
    tools: {
      rspack(options) {
        // изменяем конфигурацию rspack
      },
    },
  },
});

    Компиляция MDX

    Компиляция MDX в Rspress построена на базе unified. Вы можете подключать соответствующие плагины обработки через конфигурацию markdown. Например:

    rspress.config.ts
    import { defineConfig } from '@rspress/core';

export default defineConfig({
  markdown: {
    remarkPlugins: [
      [
        require('remark-autolink-headings'),
        {
          behavior: 'wrap',
        },
      ],
    ],
    rehypePlugins: [require('rehype-slug')],
  },
});