summaryrefslogtreecommitdiff
path: root/node_modules/@tailwindcss/nesting/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@tailwindcss/nesting/README.md')
-rw-r--r--node_modules/@tailwindcss/nesting/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/@tailwindcss/nesting/README.md b/node_modules/@tailwindcss/nesting/README.md
new file mode 100644
index 0000000..ab1d3eb
--- /dev/null
+++ b/node_modules/@tailwindcss/nesting/README.md
@@ -0,0 +1,47 @@
+# @tailwindcss/nesting
+
+This is a PostCSS plugin that wraps [postcss-nested](https://github.com/postcss/postcss-nested) or [postcss-nesting](https://github.com/jonathantneal/postcss-nesting) and acts as a compatibility layer to make sure your nesting plugin of choice properly understands custom syntax like `@apply` and `@screen`.
+
+To use it, install it via npm:
+
+```shell
+npm install @tailwindcss/nesting
+```
+
+Then add it to your PostCSS configuration, somewhere before Tailwind itself:
+
+```js
+// postcss.config.js
+module.exports = {
+ plugins: [
+ require('postcss-import'),
+ require('@tailwindcss/nesting'),
+ require('tailwindcss'),
+ require('autoprefixer'),
+ ]
+}
+```
+
+By default, it uses the [postcss-nested](https://github.com/postcss/postcss-nested) plugin under the hood, which uses a Sass-like syntax and is the plugin that powers nesting support in the [Tailwind CSS plugin API](https://tailwindcss.com/docs/plugins#css-in-js-syntax).
+
+If you'd rather use [postcss-nesting](https://github.com/jonathantneal/postcss-nesting) (which is based on the work-in-progress [CSS Nesting](https://drafts.csswg.org/css-nesting-1/) specification), first install the plugin alongside `@tailwindcss/nesting`:
+
+```shell
+npm install @tailwindcss/nesting postcss-nesting
+```
+
+Then pass the plugin itself as an argument to `@tailwindcss/nesting` in your PostCSS configuration:
+
+```js
+// postcss.config.js
+module.exports = {
+ plugins: [
+ require('postcss-import'),
+ require('@tailwindcss/nesting')(require('postcss-nesting')),
+ require('tailwindcss'),
+ require('autoprefixer'),
+ ]
+}
+```
+
+This can also be helpful if for whatever reason you need to use a very specific version of `postcss-nested` and want to override the version we bundle with `@tailwindcss/nesting` itself.