summaryrefslogtreecommitdiff
path: root/node_modules/postcss-overflow-shorthand/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/postcss-overflow-shorthand/README.md')
-rw-r--r--node_modules/postcss-overflow-shorthand/README.md87
1 files changed, 0 insertions, 87 deletions
diff --git a/node_modules/postcss-overflow-shorthand/README.md b/node_modules/postcss-overflow-shorthand/README.md
deleted file mode 100644
index ba9145ca..00000000
--- a/node_modules/postcss-overflow-shorthand/README.md
+++ /dev/null
@@ -1,87 +0,0 @@
-# PostCSS Overflow Shorthand [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][PostCSS]
-
-[<img alt="npm version" src="https://img.shields.io/npm/v/postcss-overflow-shorthand.svg" height="20">][npm-url] [<img alt="CSS Standard Status" src="https://cssdb.org/images/badges/overflow-property.svg" height="20">][css-url] [<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url] [<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
-
-```bash
-npm install postcss-overflow-shorthand --save-dev
-```
-
-[PostCSS Overflow Shorthand] lets you use the `overflow` shorthand in CSS,
-following the [CSS Overflow] specification.
-
-```pcss
-html {
- overflow: hidden auto;
-}
-
-/* becomes */
-
-html {
- overflow-x: hidden;
- overflow-y: auto;
- overflow: hidden auto;
-}
-```
-
-## Usage
-
-Add [PostCSS Overflow Shorthand] to your project:
-
-```bash
-npm install postcss postcss-overflow-shorthand --save-dev
-```
-
-Use it as a [PostCSS] plugin:
-
-```js
-const postcss = require('postcss');
-const postcssOverflowShorthand = require('postcss-overflow-shorthand');
-
-postcss([
- postcssOverflowShorthand(/* pluginOptions */)
-]).process(YOUR_CSS /*, processOptions */);
-```
-
-[PostCSS Overflow Shorthand] runs in all Node environments, with special
-instructions for:
-
-- [Node](INSTALL.md#node)
-- [PostCSS CLI](INSTALL.md#postcss-cli)
-- [PostCSS Load Config](INSTALL.md#postcss-load-config)
-- [Webpack](INSTALL.md#webpack)
-- [Next.js](INSTALL.md#nextjs)
-- [Gulp](INSTALL.md#gulp)
-- [Grunt](INSTALL.md#grunt)
-
-## Options
-
-### preserve
-
-The `preserve` option determines whether the original notation
-is preserved. By default, it is preserved.
-
-```js
-postcssOverflowShorthand({ preserve: false })
-```
-
-```pcss
-html {
- overflow: hidden auto;
-}
-
-/* becomes */
-
-html {
- overflow-x: hidden;
- overflow-y: auto;
-}
-```
-
-[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
-[css-url]: https://cssdb.org/#overflow-property
-[discord]: https://discord.gg/bUadyRwkJS
-[npm-url]: https://www.npmjs.com/package/postcss-overflow-shorthand
-
-[PostCSS]: https://github.com/postcss/postcss
-[PostCSS Overflow Shorthand]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-overflow-shorthand
-[CSS Overflow]: https://drafts.csswg.org/css-overflow/#propdef-overflow