Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roperzh/tachyons-cheatsheet
Interactive cheat sheet for Tachyons :memo:
https://github.com/roperzh/tachyons-cheatsheet
atomic-css cheatsheet css functional-css tachyons
Last synced: 6 days ago
JSON representation
Interactive cheat sheet for Tachyons :memo:
- Host: GitHub
- URL: https://github.com/roperzh/tachyons-cheatsheet
- Owner: roperzh
- License: mit
- Created: 2017-04-05T20:51:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-06-14T02:33:34.000Z (over 7 years ago)
- Last Synced: 2024-10-31T17:51:50.627Z (13 days ago)
- Topics: atomic-css, cheatsheet, css, functional-css, tachyons
- Language: JavaScript
- Homepage: http://roperzh.com/tachyons-cheatsheet
- Size: 95.7 KB
- Stars: 54
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tachyons Cheatsheet
I had a lot of trouble while learning how to use Tachyons, there are a _ton_ of
new classes to learn and I have bad memory.
So, I decided to create this interactive cheatsheet. This project does not intend
to be source of the Tachyons truth or to replace the excellent documentation. Instead,
use it as your friendly companion.
## Development
### Dependencies
- Node.js v7.x
### Getting started
If you satisfy all the dependencies, go to the root of the project and install
the required node modules:
```bash
$ npm install
```
Then, just start your server by running:
```bash
$ npm run start
```
### Generating documentation
All the documentation is stored in `yml` files under the `docs` folder, this
files are parsed and converted to a single `json` file located in `app/assets/data.json`.
In order to parse the `yml` to `json` you need to run the `docs2json` script:
```bash
$ npm run docs
```
### Deploy
First and foremost, you need to configure your deploy.sh file,
a sample is provided in the document root. Then just run:
```bash
$ npm run deploy
```
Voilà!
## 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
## License
All the code contained in this repository, unless explicitly stated, is
licensed under an MIT license.
A copy of the license can be found in the [LICENSE](LICENSE) file.