Skip to content

jinhang87/vuepress-plugin-tailwind

 
 

Repository files navigation

@jinhang/vuepress-plugin-tailwind

GitHub package.json version npm downloads appveyor CI-CD Compatibility Score Dependencies GitHub code size in bytes Netlify Codacy grade LICENSE

A VuePress(2.x) plugin to use tailwindcss easily.

With this plugin, you can use any classes defined by Tailwind CSS, and the unused classes are automatically purged (production only).

This plugin is based on the official guide of Tailwind CSS.

Usage

  1. Install this plugin :
yarn add @jinhang/vuepress-plugin-tailwind
  1. Add @tailwind import statements to the beginning of .vuepress/styles/index.sass :
@tailwind base;
@tailwind components;
@tailwind utilities;

// Add your style definitions below...
  1. Load this plugin in .vuepress/config.js :
module.exports = {
  plugins: ["@jinhang/tailwind"],
};

⚠️ These configuration files are not created automatically. You have to create them if not exist.

Options

See docs.

Versioning policy

Since v1.0.0, the versioning of this plugin will follow that of Tailwind.

For example, when there is a major version upgrade of Tailwind, this plugin also gets a major upgrade.

License

MIT