https://github.com/praveenjuge/windstrap

Tailwind CSS with Bootstrap JS
https://github.com/praveenjuge/windstrap

tailwind tailwind-plugin tailwindcss tailwindcss-plugin

Last synced: 3 months ago
JSON representation

Tailwind CSS with Bootstrap JS

• Host: GitHub
• URL: https://github.com/praveenjuge/windstrap
• Owner: praveenjuge
• License: mit
• Created: 2020-12-08T14:10:53.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-23T12:02:55.000Z (about 4 years ago)
• Last Synced: 2024-09-30T19:01:20.781Z (3 months ago)
• Topics: tailwind, tailwind-plugin, tailwindcss, tailwindcss-plugin
• Language: JavaScript
• Homepage: https://windstrap.netlify.app
• Size: 344 KB
• Stars: 69
• Watchers: 5
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Windstrap

Tailwind CSS with Bootstrap JS

## Installation

```sh

npm install windstrap --save

```

Require the installed plugin directly to your Tailwind config:

```js

// 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.

```js

// 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](https://tailwindcss.com/docs/installation/).

### For JS

Requires Bootstrap JS 5.0.0-beta1 which is not included in this package. Learn how to [install bootstrap js here](https://getbootstrap.com/docs/5.0/getting-started/introduction/#js).

## Documentation

View full documentation at [https://windstrap.netlify.app](https://windstrap.netlify.app).

## Bugs

Found a bug? [Please open a new issue](https://github.com/praveenjuge/windstrap/issues/new).

## Development

You need [Hugo](https://gohugo.io/) to run the dev server. If you have [Homebrew](https://brew.sh/) you can do the following:

```sh

brew install hugo

```

Check this [Hugo installation page](https://gohugo.io/getting-started/installing/) for installing on other systems.

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

```sh

git clone https://github.com/praveenjuge/windstrap.git

cd windstrap

npm install

npm start

```

Open [`http://localhost:1313`](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](https://github.com/praveenjuge/windstrap/blob/master/LICENSE) file.