Search code examples
sassdocusaurus

How do use Sass in Docusaurus v2?


I followed the instructions to use Sass in my Docusaurus v2 project, but I get the following error when I run yarn start:

Error: Cannot find module 'docusaurus-plugin-sass'

My config file is straight out of the box:

module.exports = {
  title: '...',
  tagline: '...',
  url: '...',
  baseUrl: '/',
  favicon: 'img/favicon.ico',
  organizationName: '...', // Usually your GitHub org/user name.
  projectName: '...', // Usually your repo name.
  themeConfig: {
    navbar: {...},
    footer: {...},
  },
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {...},
        blog: {...},
        theme: {
          customCss: require.resolve('./src/scss/index.scss'),
        },
      },
    ],
  ],
  plugins: ['docusaurus-plugin-sass'],
};

Is this a bug or am I missing something?


Solution

  • Few things to check

    If you refer to modules (plugins) in your config file in a string form, you will need to replace them with require.resolve calls, for example:

    - plugins: ['@docusaurus/plugin-google-analytics']
    + plugins: [require.resolve('@docusaurus/plugin-google-analytics')]