UNPKG

ciser

Version:

Functional CSS, help quickly build and design new UI without writing css.

179 lines (142 loc) 4.25 kB
# tachyons-cli 1.0.11 Postprocess tachyons stylesheets #### Stats 648 | 55 | 45 ---|---|--- 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 @import "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 /* TYPE SCALE Docs: http://tachyons.io/docs/typography/scale/ Base: f = font-size Modifiers 1 = 1st step in size scale 2 = 2nd step in size scale 3 = 3rd step in size scale 4 = 4th step in size scale 5 = 5th step in size scale 6 = 6th step in size scale 7 = 7th step in size scale Media Query Extensions: -ns = not-small -m = medium -ml = mobile landscape -l = large */ /* * For Hero/Marketing Titles * * These generally are too large for mobile * so be careful using them on smaller screens. * */ .f-6, .f-headline { font-size: 6rem; } .f-5, .f-subheadline { font-size: 5rem; } /* Type Scale */ .f1 { font-size: 3rem; } .f2 { font-size: 2.25rem; } .f3 { font-size: 1.5rem; } .f4 { font-size: 1.25rem; } .f5 { font-size: 1rem; } .f6 { font-size: .875rem; } .f7 { font-size: .75rem; } /* Small and hard to read for many people so use with extreme caution */ @media screen and (min-width: 30em) { .f-6-ns, .f-headline-ns { font-size: 6rem; } .f-5-ns, .f-subheadline-ns { font-size: 5rem; } .f1-ns { font-size: 3rem; } .f2-ns { font-size: 2.25rem; } .f3-ns { font-size: 1.5rem; } .f4-ns { font-size: 1.25rem; } .f5-ns { font-size: 1rem; } .f6-ns { font-size: .875rem; } .f7-ns { font-size: .75rem; } } @media screen and (min-width: 30em) and (max-width: 60em) { .f-6-m, .f-headline-m { font-size: 6rem; } .f-5-m, .f-subheadline-m { font-size: 5rem; } .f1-m { font-size: 3rem; } .f2-m { font-size: 2.25rem; } .f3-m { font-size: 1.5rem; } .f4-m { font-size: 1.25rem; } .f5-m { font-size: 1rem; } .f6-m { font-size: .875rem; } .f7-m { font-size: .75rem; } } @media screen and (max-width: 60em) and (orientation: landscape) { .f-6-ml, .f-headline-ml { font-size: 6rem; } .f-5-ml, .f-subheadline-ml { font-size: 5rem; } .f1-ml { font-size: 3rem; } .f2-ml { font-size: 2.25rem; } .f3-ml { font-size: 1.5rem; } .f4-ml { font-size: 1.25rem; } .f5-ml { font-size: 1rem; } .f6-ml { font-size: .875rem; } .f7-ml { font-size: .75rem; } } @media screen and (min-width: 60em) { .f-6-l, .f-headline-l { font-size: 6rem; } .f-5-l, .f-subheadline-l { font-size: 5rem; } .f1-l { font-size: 3rem; } .f2-l { font-size: 2.25rem; } .f3-l { font-size: 1.5rem; } .f4-l { font-size: 1.25rem; } .f5-l { font-size: 1rem; } .f6-l { font-size: .875rem; } .f7-l { font-size: .75rem; } } ``` ## 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