Getting Started

Installation

npm install --save-dev stylelint stylelint-plugin-docusaurus

Quick start with a shareable config

import { docusaurusPluginConfigs } from "stylelint-plugin-docusaurus";

export default docusaurusPluginConfigs["docusaurus-recommended"];

Quick start with extends

export default {
 extends: [
  "stylelint-config-standard",
  "stylelint-config-recess-order",
  "stylelint-config-idiomatic-order",
  "stylelint-config-standard-scss",
  "stylelint-config-tailwindcss",
  "stylelint-plugin-docusaurus/configs/docusaurus-recommended",
 ],
};

Manual plugin registration

If you prefer to compose rules manually:

import docusaurusPlugin from "stylelint-plugin-docusaurus";

export default {
 plugins: ["stylelint-plugin-docusaurus"],
 // Alternative explicit pack form:
 // plugins: [...docusaurusPlugin],
 rules: {
  "docusaurus/no-mobile-navbar-backdrop-filter": true,
 },
};

This package default-exports a plugin-pack array, so both plugin registration forms are supported.