📦 plugin-svgr

SVGR 插件，用于在构建时自动将 SVG 文件转换为 React 组件。

¥An SVGR plugin to transform SVG files into React components automatically at build time.

安装

¥Installation

npm

npm install --save @docusaurus/plugin-svgr

Yarn

yarn add @docusaurus/plugin-svgr

pnpm

pnpm add @docusaurus/plugin-svgr

提示

如果你使用预设 @docusaurus/preset-classic，则无需安装此插件作为依赖。

¥If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

你可以通过 预设选项.conf 配置该插件。

¥You can configure this plugin through the preset options.

配置

¥Configuration

接受的字段：

¥Accepted fields:

名称	类型	默认	描述
svgrConfig	object	{}	SVGR 配置选项，按原样转发

配置示例

¥Example configuration

你可以通过插件选项配置此插件。

¥You can configure this plugin through plugin options.

Preset options

If you use a preset, configure this plugin through the preset options:

docusaurus.config.js

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        svgr: {
          svgrConfig: {
            /* SVGR config */
          },
        },
      },
    ],
  ],
};

Plugin options

If you are using a standalone plugin, provide options directly to the plugin:

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-svgr',
      {
        svgrConfig: {
          /* SVGR config */
        },
      },
    ],
  ],
};