https://github.com/twbs/stylelint-config-twbs-bootstrap

Stylelint config for Bootstrap
https://github.com/twbs/stylelint-config-twbs-bootstrap

bootstrap bootstrap-4 bootstrap-5 css sass scss stylelint stylelint-config

Last synced: 4 days ago
JSON representation

Stylelint config for Bootstrap

• Host: GitHub
• URL: https://github.com/twbs/stylelint-config-twbs-bootstrap
• Owner: twbs
• License: mit
• Created: 2018-12-30T15:27:51.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T14:25:54.000Z (4 months ago)
• Last Synced: 2024-10-29T14:48:07.655Z (3 months ago)
• Topics: bootstrap, bootstrap-4, bootstrap-5, css, sass, scss, stylelint, stylelint-config
• Language: JavaScript
• Homepage: https://getbootstrap.com
• Size: 972 KB
• Stars: 152
• Watchers: 12
• Forks: 33
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stylelint-config-twbs-bootstrap [![npm version](https://img.shields.io/npm/v/stylelint-config-twbs-bootstrap?logo=npm&logoColor=fff)](https://www.npmjs.com/package/stylelint-config-twbs-bootstrap) [![CI Status](https://img.shields.io/github/actions/workflow/status/twbs/stylelint-config-twbs-bootstrap/test.yml?branch=main&label=CI&logo=github)](https://github.com/twbs/stylelint-config-twbs-bootstrap/actions/workflows/test.yml?query=workflow%3ATests+branch%3Amain)

> An opinionated Stylelint config used by Bootstrap across our projects.

## Installation

```bash

npm install stylelint-config-twbs-bootstrap --save-dev

# Or with yarn:

yarn add stylelint-config-twbs-bootstrap --dev

```

## Usage

We provide a single config that covers both CSS and SCSS. It will automatically apply SCSS rules to files ending in `.scss`.

You simply have to extend this config in your Stylelint config:

```json

{

  "extends": "stylelint-config-twbs-bootstrap"

}

```

To see the included rules, please check [index.js](index.js).

## License

Released under the [MIT License](LICENSE).