@pixelmatters/stylelint-config-pixelmatters

Stylelint config for usage in Pixelmatters projects

Usage no npm install needed!

<script type="module">
  import pixelmattersStylelintConfigPixelmatters from 'https://cdn.skypack.dev/@pixelmatters/stylelint-config-pixelmatters';
</script>

README

stylelint-config-pixelmatters

A Stylelint config standard for Pixelmatters projects

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

stylelint-config-pixelmatters is released under the MIT license. Current npm package version. PRs welcome! Follow @pixelmatters_

🚀 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
  1. Add all the missing peer dependencies:
npx install-peerdeps @pixelmatters/stylelint-config-pixelmatters --dev --yarn
  1. 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
  1. Add all the missing peer dependencies:
npx install-peerdeps @pixelmatters/stylelint-config-pixelmatters --dev
  1. 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.

:memo: License

Licensed under the MIT License.