📦 theme-classic

The classic theme for Docusaurus.

You can refer to the theme configuration page for more details on the configuration.

npm

npm install --save @docusaurus/theme-classic

Yarn

yarn add @docusaurus/theme-classic

pnpm

pnpm add @docusaurus/theme-classic

tip

If you have installed @docusaurus/preset-classic, you don't need to install it as a dependency.

Configuration

Accepted fields:

Option	Type	Default	Description
customCss	string[] | string	[]	Stylesheets to be imported globally as client modules. Relative paths are resolved against the site directory.

note

Most configuration for the theme is done in themeConfig, which can be found in theme configuration.

Example configuration

You can configure this theme through preset options or plugin options.

tip

Most Docusaurus users configure this plugin through the preset options.

Preset options

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

docusaurus.config.js

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      },
    ],
  ],
};

Plugin options

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

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/theme-classic',
      {
        customCss: require.resolve('./src/css/custom.css'),
      },
    ],
  ],
};