1 | [![@nuxtjs/tailwindcss](https://tailwindcss.nuxtjs.org/preview.png)](https://tailwindcss.nuxtjs.org)
|
2 |
|
3 | # @nuxtjs/tailwindcss
|
4 |
|
5 | [![npm version][npm-version-src]][npm-version-href]
|
6 | [![npm downloads][npm-downloads-src]][npm-downloads-href]
|
7 | [![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
|
8 | [![Codecov][codecov-src]][codecov-href]
|
9 | [![License][license-src]][license-href]
|
10 |
|
11 | > [Tailwind CSS](https://tailwindcss.com) module for [NuxtJS](https://nuxtjs.org) with [modern css](https://tailwindcss.com/docs/using-with-preprocessors#future-css-features) âĄī¸
|
12 |
|
13 | - [⨠Release Notes](https://tailwindcss.nuxtjs.org/releases)
|
14 | - [đ Documentation](https://tailwindcss.nuxtjs.org)
|
15 |
|
16 | ## Features
|
17 |
|
18 | - đ Zero configuration to start *([see video](https://tailwindcss.nuxtjs.org/#quick-start))*
|
19 | - âĄī¸ PurgeCSS included for minimal CSS âĄī¸
|
20 | - đĒ Use latest CSS features *([Stage 1](https://cssdb.org/#stage-1))*
|
21 | - đ¨ Discover your Tailwind Colors *([see video](https://tailwindcss.nuxtjs.org/#tailwind-colors))*
|
22 | - âī¸ Reference your Tailwind config in your app
|
23 | - đĻ Extendable by [Nuxt modules](https://modules.nuxtjs.org/)
|
24 |
|
25 | [đ Read more](https://tailwindcss.nuxtjs.org)
|
26 |
|
27 | ## Quick Setup
|
28 |
|
29 | 1. Add `@nuxtjs/tailwindcss` dependency to your project
|
30 |
|
31 | ```bash
|
32 | # Using npm
|
33 | npm install --save-dev @nuxtjs/tailwindcss
|
34 | # Using yarn
|
35 | yarn add --dev @nuxtjs/tailwindcss
|
36 | ```
|
37 |
|
38 | 2. Add `@nuxtjs/tailwindcss` to the `buildModules` section of `nuxt.config.js`
|
39 |
|
40 | ```js
|
41 | {
|
42 | buildModules: [
|
43 | '@nuxtjs/tailwindcss'
|
44 | ]
|
45 | }
|
46 | ```
|
47 |
|
48 | âšī¸ If you are using `nuxt < 2.9.0`, use `modules` property instead.
|
49 |
|
50 | That's it! You can now use Tailwind classes in your Nuxt app â¨
|
51 |
|
52 | [đ Read more](https://tailwindcss.nuxtjs.org/setup)
|
53 |
|
54 | ## Contributing
|
55 |
|
56 | You can contribute to this module online with CodeSandBox:
|
57 |
|
58 | [![Edit @nuxtjs/tailwindcss](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/nuxt-community/tailwindcss-module/tree/master/?fontsize=14&hidenavigation=1&theme=dark)
|
59 |
|
60 | Or locally:
|
61 |
|
62 | 1. Clone this repository
|
63 | 2. Install dependencies using `yarn install` or `npm install`
|
64 | 3. Start development server using `yarn dev` or `npm run dev`
|
65 |
|
66 | ## License
|
67 |
|
68 | [MIT License](./LICENSE)
|
69 |
|
70 | Copyright (c) Nuxt.js Team
|
71 |
|
72 |
|
73 | [npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/tailwindcss/latest.svg
|
74 | [npm-version-href]: https://npmjs.com/package/@nuxtjs/tailwindcss
|
75 |
|
76 | [npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/tailwindcss.svg
|
77 | [npm-downloads-href]: https://npmjs.com/package/@nuxtjs/tailwindcss
|
78 |
|
79 | [github-actions-ci-src]: https://github.com/nuxt-community/tailwindcss-module/workflows/ci/badge.svg
|
80 | [github-actions-ci-href]: https://github.com/nuxt-community/tailwindcss-module/actions?query=workflow%3Aci
|
81 |
|
82 | [codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/tailwindcss-module.svg
|
83 | [codecov-href]: https://codecov.io/gh/nuxt-community/tailwindcss-module
|
84 |
|
85 | [license-src]: https://img.shields.io/npm/l/@nuxtjs/tailwindcss.svg
|
86 | [license-href]: https://npmjs.com/package/@nuxtjs/tailwindcss
|