Skip to content

Latest commit

 

History

History
executable file
·
68 lines (51 loc) · 2.61 KB

README.md

File metadata and controls

executable file
·
68 lines (51 loc) · 2.61 KB

nuxt-tailwindcss

npm version npm downloads circle ci coverage License

TailwindCSS module for Nuxt.js with nuxt-purgecss + modern css ⚡️

Infos

Setup

  1. Add @nuxtjs/tailwindcss dependency to your project
npm install --save-dev @nuxtjs/tailwindcss # or yarn add --dev @nuxtjs/tailwindcss
  1. Add @nuxtjs/tailwindcss to the devModules section of nuxt.config.js
{
  devModules: [
    '@nuxtjs/tailwindcss'
  ]
}

Usage

This module will automatically create two files in your srcDir:

  • ~/tailwind.config.js
  • ~/assets/css/tailwind.css

It will also inject the CSS file globally and configure nuxt-purgecss and postcss-preset-env to stage 1.

Configuration

If you want to set a different path for the configuration file or css file, you can use these given options:

// nuxt.config.js
{
  devModules: [
    '@nuxtjs/tailwindcss'
  ],
  tailwindcss: {
    configPath: '~/config/tailwind.config.js',
    cssPath: '~/assets/css/tailwind.css'
  }
}

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using npm run dev

License

MIT License

Copyright (c) Nuxt.js Team