ciser
Version:
Functional CSS, help quickly build and design new UI without writing css.
132 lines (95 loc) • 2.87 kB
Markdown
# tachyons-cli 1.0.11
Postprocess tachyons stylesheets
#### Stats
288 | 15 | 15
---|---|---
bytes | selectors | declarations
## Installation
#### With [npm](https://npmjs.com)
```
npm install --save-dev tachyons-cli
```
Learn more about using css installed with npm:
* https://webpack.github.io/docs/stylesheets.html
* https://github.com/defunctzombie/npm-css
#### With Git
http:
```
git clone https://github.com/tachyons-css/tachyons-cli
```
ssh:
```
git clone git@github.com:tachyons-css/tachyons-cli.git
```
## Usage
#### Using with [Postcss](https://github.com/postcss/postcss)
Import the css module
```css
"tachyons-cli";
```
Then process the css using the [`tachyons-cli`](https://github.com/tachyons-css/tachyons-cli)
```sh
$ npm i -g tachyons-cli
$ tachyons path/to/css-file.css > dist/t.css
```
#### Using the css
##### CDN
The easiest and most simple way to use the css is to use the cdn hosted version. Include it in the head of your html with:
```
<link rel="stylesheet" href="http://unpkg.com/tachyons-cli@1.0.11/css/tachyons-cli.min.css" />
```
##### Locally
The built css is located in the `css` directory. It contains an unminified and minified version.
You can either cut and paste that css or link to it directly in your html.
```html
<link rel="stylesheet" href="path/to/module/css/tachyons-cli">
```
#### Development
The source css files can be found in the `src` directory.
Running `$ npm start` will process the source css and place the built css in the `css` directory.
## The css
```css
/*
WORD BREAK
Base:
word = word-break
Media Query Extensions:
-ns = not-small
-m = medium -ml = mobile landscape
-l = large
*/
.word-normal { word-break: normal; }
.word-wrap { word-break: break-all; }
.word-nowrap { word-break: keep-all; }
screen and (min-width: 30em) {
.word-normal-ns { word-break: normal; }
.word-wrap-ns { word-break: break-all; }
.word-nowrap-ns { word-break: keep-all; }
}
screen and (min-width: 30em) and (max-width: 60em) {
.word-normal-m { word-break: normal; }
.word-wrap-m { word-break: break-all; }
.word-nowrap-m { word-break: keep-all; }
}
screen and (max-width: 60em) and (orientation: landscape) {
.word-normal-ml { word-break: normal; }
.word-wrap-ml { word-break: break-all; }
.word-nowrap-ml { word-break: keep-all; }
}
screen and (min-width: 60em) {
.word-normal-l { word-break: normal; }
.word-wrap-l { word-break: break-all; }
.word-nowrap-l { word-break: keep-all; }
}
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Authors
* [mrmrs](http://mrmrs.io)
* [johno](http://johnotander.com)
## License
ISC