An open API service indexing awesome lists of open source software.

https://github.com/tachyons-css/tachyons-css.github.io

Documentation for designing faster than the speed of light
https://github.com/tachyons-css/tachyons-css.github.io

Last synced: 4 months ago
JSON representation

Documentation for designing faster than the speed of light

Awesome Lists containing this project

README

        

# Tachyons Documentation

Documentation for Tachyons — a performant, mobile-first, and 100% responsive modular css framework.

## Installation and Usage

```
git clone https://github.com/tachyons-css/tachyons-css.github.io && cd tachyons-css.github.io
npm i && npm start
```

There are other scripts available to ease development, too. See the `"scripts"` section in the `package.json`.

The `index.html`, `components`, and `docs` directories are built files. Their source can be found in the `src/` directory.
css documentation is created using a bash script called `script.sh` and can be run with `$ npm run doc`.
Component documentation is part of the build script, and can be run with `$npm run build`.

## Authors

* [mrmrs](http://mrmrs.io)
* [johno](http://johnotander.com)
* [lachlanjc](http://lachlanjc.me)

## License

MIT

## 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