Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/silvanite/vuepress-plugin-tailwind
Tailwind CSS plugin for VuePress
https://github.com/silvanite/vuepress-plugin-tailwind
Last synced: 11 days ago
JSON representation
Tailwind CSS plugin for VuePress
- Host: GitHub
- URL: https://github.com/silvanite/vuepress-plugin-tailwind
- Owner: Silvanite
- Created: 2019-02-15T22:02:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-17T19:29:29.000Z (over 4 years ago)
- Last Synced: 2024-10-12T11:06:50.956Z (27 days ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# VuePress Plugin to add Tailwind CSS
## Overview
This plugin will install Tailwind CSS ^1.1.2 ready for you to import into your VuePress theme or project. You will need to follow the [Tailwind CSS installation](https://tailwindcss.com/docs/installation/) instructions and add Tailwind to your CSS. E.g. add the tailwind directives to your styl or css files.
```styl
@tailwind base;
@tailwind components;
@tailwind utilities;
```
## Installation
```sh
npm i @silvanite/vuepress-plugin-tailwind
```
Load the plugin inside your `config.js` or in your theme's `index.js`
```js
module.exports = {
...
"plugins": [
"@silvanite/tailwind"
]
}
```
## Configuration options
Please follow the [Tailwind CSS configuration](https://tailwindcss.com/docs/configuration/) instructions. If you are using the default filename, you do not need to specify it here. If you would like to load a custom configuration file with a different filename to the default `tailwind.config.js` you can specify this in the plugin options.
```js
module.exports = {
...
"plugins": [
["@silvanite/tailwind", {
config: "./tailwind.js"
}]
]
}
```
By default PurgeCSS will be applied when running VuePress build (production). You can optionally disable this if you do not want to use PurgeCSS.
```js
module.exports = {
...
"plugins": [
["@silvanite/tailwind", {
purgecss: { enabled: false }
}]
]
}
```
## Support
If you experience any problems with this VuePress Plugin please open a new issue or get in touch on Twitter [@m2de_io](https://twitter.com/m2de_io). Or just look me up anyway, I'd love to hear from you.