postcss-structure
Advanced tools
Comparing version 0.7.6 to 0.7.7
{ | ||
"name": "postcss-structure", | ||
"version": "0.7.6", | ||
"version": "0.7.7", | ||
"description": "A PostCSS plugin to create CSS grids based on a fixed block width.", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
# postcss-structure [![Build Status][ci-img]][ci] | ||
http://francoisromain.github.io/postcss-structure/ | ||
[francoisromain.github.io/postcss-structure](http://francoisromain.github.io/postcss-structure) | ||
A [PostCSS] plugin to create CSS grids based on a fixed column width ([npm module](https://www.npmjs.com/package/postcss-structure)). | ||
A [PostCSS] to create grid systems based on a fixed column width. | ||
@@ -15,2 +15,4 @@ [PostCSS]: https://github.com/postcss/postcss | ||
Install the [npm module](https://www.npmjs.com/package/postcss-structure): | ||
$ npm install postcss-structure --save-dev | ||
@@ -24,7 +26,7 @@ | ||
See [PostCSS usage instructions](https://github.com/postcss/postcss#usage) to setup with Gulp, Grunt, Webpack, npm scripts… | ||
See [PostCSS usage](https://github.com/postcss/postcss#usage) to setup with Gulp, Grunt, Webpack, npm scripts… | ||
#### Example with [npm script](https://docs.npmjs.com/misc/scripts) and [postcss-cli](https://www.npmjs.com/package/postcss-cli). | ||
##### Example with a [npm script](https://docs.npmjs.com/misc/scripts) and [postcss-cli](https://www.npmjs.com/package/postcss-cli): | ||
Add this to package.json: | ||
Add to package.json: | ||
@@ -35,3 +37,2 @@ ``` js | ||
} | ||
// -i is the input -o is the output | ||
``` | ||
@@ -43,8 +44,6 @@ | ||
In your stylesheet, set the global settings in a `@structure` declaration: | ||
Global settings rule (and default values): | ||
``` css | ||
/* default values */ | ||
@structure { | ||
@@ -113,3 +112,3 @@ unit: 20.5rem, /* width of a single column */ | ||
- _breakpoint_: number of _units_ that fit into the screen. If the screen is narrower than the _breakpoint_, the bloc takes full width. | ||
- _breakpoint_: number of _units_ that fit into the screen. If the screen is narrower than the _breakpoint_, the bloc is fluid and takes full width. | ||
- _width_: width of the bloc. | ||
@@ -138,4 +137,4 @@ - _offset_ (optional): remaining space before the bloc can take its width. if (_width_ + _offset_) is wider than _breakpoint_, then _width_ shrinks first. | ||
- _ratio_: fraction of the total in one row. | ||
- _total_: aribitrary divider, relative to _unit_. | ||
- _ratio_: fraction of the _total_. | ||
- _total_: divider, relative to _unit_. | ||
@@ -160,3 +159,3 @@ ``` css | ||
- _ratio_: fraction of the _total_. | ||
- _total_: aribitrary divider, relative to the _breakpoint_. | ||
- _total_: divider, relative to the _breakpoint_. | ||
@@ -163,0 +162,0 @@ ``` css |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
56085
228