Cli to postprocess tachyons stylesheets and generate documentation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
templates
test
.editorconfig Implement initial functionality Oct 21, 2015
.gitignore
.npmrc
.travis.yml Upgraded node versions in .travis.yml Apr 14, 2017
cli.js
license Update copyright date Jan 3, 2017
package.json
readme.md

readme.md

tachyons-cli Build Status js-standard-style

Postprocess Tachyons stylesheets with a CLI app.

This module is used to process Tachyons css modules and generate their documentation. It is leveraged in an npm script shared among all modules.

It is meant to be installed globally with the --global flag, and requires v4 of node or higher.

Installation

npm install --global tachyons-cli

Usage

$ tachyons --help

  Postprocess tachyons stylesheets

  Usage
    $ tachyons <input.css>

  Options
    -m, --minify Minify the output stylesheet
    -r, --repeat Repeat class names to increase specificity
    -a, --authors Dynamically add authors based on package.json
    -n, --new Generate a new Tachyons project
    --generate-docs Generate documentation for a given module
    --package The path to the module package to be documented

  Example
    $ tachyons src/tachyons.css > dist/c.css
    $ tachyons src/tachyons.css > dist/c.css --minify
    $ tachyons src/tachyons.css > dist/c.repeated.css --repeat
    $ tachyons src/tachyons-type-scale.css --generate-docs --package=./package.json > readme.md
    $ tachyons --new=my-new-project

Within a Tachyons css module

$ tachyons src/tachyons-base.css > css/tachyons-base.css && \
  tachyons src/tachyons-base.css --minify > css/tachyons-base.min.css && \
  tachyons src/tachyons-base.css --generate-docs --package=../../package.json > readme.md

Development

$ npm t

Related

License

ISC

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

Crafted with <3 by John Otander (@4lpine).


This package was initially generated with yeoman and the p generator.