readme.md

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 instructions and add Tailwind to your CSS. E.g. add the tailwind directives to your styl or css files.

@tailwind base;
@tailwind components;
@tailwind utilities;

Installation

npm i @silvanite/vuepress-plugin-tailwind

Load the plugin inside your config.js or in your theme's index.js

module.exports = {
    ...
    "plugins": [
        "@silvanite/tailwind"
    ]
}

Configuration options

Please follow the Tailwind CSS 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.

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.

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. Or just look me up anyway, I'd love to hear from you.