stylelint-config-pixelmatters

A Stylelint config standard for Pixelmatters projects

This is a Stylelint config that you can use in your projects.

🚀 Get Up and Running

You can install this package using either npm or yarn.

Yarn

If using Yarn:

1. Install the package as a development dependency:

yarn add @pixelmatters/stylelint-config-pixelmatters --dev

2. Add all the missing peer dependencies:

npx install-peerdeps @pixelmatters/stylelint-config-pixelmatters --dev --yarn

3. Create a .stylelintrc.js in the root of your project and add the following code:

module.exports = {
  extends: '@pixelmatters/stylelint-config-pixelmatters',
};

NPM

If using NPM:

1. Install the package as a development dependency::

npm install @pixelmatters/stylelint-config-pixelmatters --save-dev

2. Add all the missing peer dependencies:

npx install-peerdeps @pixelmatters/stylelint-config-pixelmatters --dev

3. Create a .stylelintrc.js in the root of your project and add the following code:

module.exports = {
  extends: '@pixelmatters/stylelint-config-pixelmatters',
};

At this point you should be good to go 👍

🤝 How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, thank you! 💪 🧡

Check out our Contributing Guide for ideas on contributing and setup steps.

📝 License

Licensed under the MIT License.