@pixelmatters/stylelint-config-pixelmatters

Stylelint config for usage in Pixelmatters projects

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@pixelmatters/stylelint-config-pixelmatters
102.0.0a year ago3 years agoMinified + gzip package size for @pixelmatters/stylelint-config-pixelmatters in KB

Readme

stylelint-config-pixelmatters

A Stylelint config standard for Pixelmatters projects


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


<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="stylelint-config-pixelmatters is released under the MIT license." />
<img src="https://img.shields.io/npm/v/@pixelmatters/stylelint-config-pixelmatters.svg" alt="Current npm package version." />
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
<img src="https://img.shields.io/twitter/follow/pixelmatters_.svg?label=Follow%20@pixelmatters_" alt="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.