CDN

Before getting started please note, many of the features that make Tailwind CSS great are not available using the CDN builds. To take full advantage of Tailwind’s features, install Tailwind via npm.

To pull in Tailwind for quick demos or just giving the framework a spin, grab the latest default configuration build via CDN:

  1. <link href="https://cdn.jsdelivr.net/npm/tailwindcss@0.7.4/dist/tailwind.min.css" rel="stylesheet">

Or if you’d like to pull in the base styles separate from the utility classes:

  1. <link href="https://cdn.jsdelivr.net/npm/tailwindcss@0.7.4/dist/preflight.min.css" rel="stylesheet">
  2. <!-- Any of your own CSS would go here -->
  3. <link href="https://cdn.jsdelivr.net/npm/tailwindcss@0.7.4/dist/utilities.min.css" rel="stylesheet">

NPM

For most projects (and to take advantage of Tailwind’s customization features), you’ll want to install Tailwind via npm.

1. Install Tailwind via npm

Tailwind is available on npm and can be installed using npm or Yarn.

Installation - 图1

2. Create a Tailwind config file

Tailwind is configured almost entirely in plain JavaScript. To do this you’ll need to generate a Tailwind config file for your project. We recommend creating a tailwind.js file in your project’s root.

We’ve provided a CLI utility to do this easily:

Installation - 图2

If you’re an experienced Tailwind user who doesn’t need the comments in the config file, use the --no-comments flag when generating your config file to strip them out.

3. Use Tailwind in your CSS

Use the @tailwind directive to inject Tailwind’s preflight and utilities styles into your CSS.

To avoid specificity issues, we highly recommend structuring your main stylesheet like this:

  1. /**
  2. * This injects Tailwind's base styles, which is a combination of
  3. * Normalize.css and some additional base styles.
  4. *
  5. * You can see the styles here:
  6. * https://github.com/tailwindcss/tailwindcss/blob/master/css/preflight.css
  7. *
  8. * If using `postcss-import`, use this import instead:
  9. *
  10. * @import "tailwindcss/preflight";
  11. */
  12. @tailwind preflight;
  13. /**
  14. * This injects any component classes registered by plugins.
  15. *
  16. * If using `postcss-import`, use this import instead:
  17. *
  18. * @import "tailwindcss/components";
  19. */
  20. @tailwind components;
  21. /**
  22. * Here you would add any of your custom component classes; stuff that you'd
  23. * want loaded *before* the utilities so that the utilities could still
  24. * override them.
  25. *
  26. * Example:
  27. *
  28. * .btn { ... }
  29. * .form-input { ... }
  30. *
  31. * Or if using a preprocessor or `postcss-import`:
  32. *
  33. * @import "components/buttons";
  34. * @import "components/forms";
  35. */
  36. /**
  37. * This injects all of Tailwind's utility classes, generated based on your
  38. * config file.
  39. *
  40. * If using `postcss-import`, use this import instead:
  41. *
  42. * @import "tailwindcss/utilities";
  43. */
  44. @tailwind utilities;
  45. /**
  46. * Here you would add any custom utilities you need that don't come out of the
  47. * box with Tailwind.
  48. *
  49. * Example :
  50. *
  51. * .bg-pattern-graph-paper { ... }
  52. * .skew-45 { ... }
  53. *
  54. * Or if using a preprocessor or `postcss-import`:
  55. *
  56. * @import "utilities/background-patterns";
  57. * @import "utilities/skew-transforms";
  58. */

4. Process your CSS with Tailwind

Using Tailwind CLI

For simple projects or just giving Tailwind a spin, you can use the Tailwind CLI tool to process your CSS:

Installation - 图3

Use the npx tailwind help build command to learn more about the various CLI options.

Using Tailwind with PostCSS

For most projects, you’ll want to add Tailwind as a PostCSS plugin in your build chain.

We’ve included the Tailwind-specific instructions for a few popular tools below, but for instructions on getting started with PostCSS in general, see the PostCSS documentation.

Webpack

Add tailwindcss as a plugin in your postcss.config.js file, passing the path to your config file:

  1. var tailwindcss = require('tailwindcss');
  2. module.exports = {
  3. plugins: [
  4. // ...
  5. tailwindcss('./path/to/your/tailwind.js'),
  6. require('autoprefixer'),
  7. // ...
  8. ]
  9. }

For a complete example, check out our webpack-starter template.

Gulp

Add tailwindcss to the list of plugins you pass to gulp-postcss, passing the path to your config file:

  1. gulp.task('css', function () {
  2. var postcss = require('gulp-postcss');
  3. var tailwindcss = require('tailwindcss');
  4. return gulp.src('src/styles.css')
  5. // ...
  6. .pipe(postcss([
  7. // ...
  8. tailwindcss('./path/to/your/tailwind.js'),
  9. require('autoprefixer'),
  10. // ...
  11. ]))
  12. // ...
  13. .pipe(gulp.dest('build/'));
  14. });

Laravel Mix

If you’re writing your project in plain CSS, use Mix’s postCss method to process your CSS. Include tailwindcss as a plugin and pass the path to your config file:

  1. var tailwindcss = require('tailwindcss');
  2. mix.postCss('resources/css/main.css', 'public/css', [
  3. tailwindcss('./path/to/your/tailwind.js'),
  4. ]);

If you’re using a preprocessor, use the options method to add tailwindcss as a PostCSS plugin:

  1. var tailwindcss = require('tailwindcss');
  2. mix.less('resources/less/app.less', 'public/css')
  3. .options({
  4. postCss: [
  5. tailwindcss('./path/to/your/tailwind.js'),
  6. ]
  7. });

Note for Sass users: Due to an unresolved issue with one of Mix’s dependencies, to use Sass with Tailwind you’ll need to disable processCssUrls:

  1. var tailwindcss = require('tailwindcss');
  2. mix.sass('resources/sass/app.scss', 'public/css')
  3. .options({
  4. processCssUrls: false,
  5. postCss: [ tailwindcss('./path/to/your/tailwind.js') ],
  6. });

For more information on what this feature does and the implications of disabling it, see the Laravel Mix documentation.

Webpack Encore

Create a postcss.config.js file, add tailwindcss as a plugin and pass the path to your config file:

  1. module.exports = {
  2. plugins: [
  3. require('tailwindcss')('./path/to/your/tailwind.js'),
  4. ]
  5. }

Within webpack.config.js, create a style entry and enable the PostCSS loader.

  1. var Encore = require('@symfony/webpack-encore');
  2. Encore
  3. .setOutputPath('public/build/')
  4. .setPublicPath('/build')
  5. .addStyleEntry('app', './css/app.css')
  6. .enablePostCssLoader()
  7. ;
  8. module.exports = Encore.getWebpackConfig();

You can also pass options into the PostCSS loader by passing a callback, as per the Encore PostCSS docs:

  1. .enablePostCssLoader(function(options) {
  2. options.config = {
  3. path: 'config/postcss.config.js'
  4. };
  5. })

Note for Sass users: Due to an unresolved issue with one of Encore’s dependencies, to use Sass with Tailwind you’ll need to disable resolveUrlLoader:

  1. Encore
  2. .enableSassLoader(function (options) {}, {
  3. resolveUrlLoader: false
  4. })
  5. ;

Brunch

Add tailwindcss to the list of processors you pass to postcss-brunch, passing the path to your config file:

  1. exports.config = {
  2. // ..
  3. plugins: {
  4. // ...
  5. postcss: {
  6. processors: [
  7. require('tailwindcss')('./tailwind.js')
  8. ]
  9. }
  10. // ...
  11. }
  12. };