praveenjuge / windstrap

Tailwind CSS with Bootstrap JS

Windstrap

Tailwind CSS with Bootstrap JS

Installation

npm install windstrap --save

Require the installed plugin directly to your Tailwind config:

// tailwind.config.js
plugins: [require("windstrap")],

Tailwind purges everything by default. Some bootstrap classes like tooltips will be left out during the purge so add the following to purge options in your tailwind config. This will make sure all components are not purged.

// tailwind.config.js
purge: {
  layers: ["base", "utilities"],
},

Requirements

For CSS

Requires Tailwind CSS 2 which is not included in this package. Learn how to install tailwind here.

For JS

Requires Bootstrap JS 5.0.0-beta1 which is not included in this package. Learn how to install bootstrap js here.

Documentation

View full documentation at https://windstrap.netlify.app.

Bugs

Found a bug? Please open a new issue.

Development

You need Hugo to run the dev server. If you have Homebrew you can do the following:

brew install hugo

Check this Hugo installation page for installing on other systems.

Then clone the repo, install dependencies, and start the server locally.

git clone https://github.com/praveenjuge/windstrap.git
cd windstrap
npm install
npm start

Open http://localhost:1313 in your browser.

Scripts	Description
npm start	Starts a local Hugo server and Tailwind Watcher
npm run production	For generating production docs files

License

See the LICENSE file.