@nypl/design-toolkit
Version:
NYPL Design Toolkit
36 lines (25 loc) • 1.75 kB
Markdown
[](https://travis-ci.org/NYPL/design-toolkit)
[](https://waffle.io/NYPL/design-toolkit?utm_source=badge)
# NYPL Digital Design Toolkit
Design toolkit (SASS) for the NYPL Digital team
## Version: 0.1.38
## [View documentation](http://nypl.github.io/design-toolkit/)
## Viewing documentation locally
### Setting up Jekyll
1. Install [Jekyll](https://jekyllrb.com/) Enter `gem install jekyll bundler` in your terminal.
2. Change directories to the `docs/` folder.
3. Run `bundle install` to install necessary gems.
4. Run `bundle exec jekyll serve` to compile and watch the site as well as start a local server. Or just run `jekyll serve`.
5. Navigate your favorite internet browser to http://127.0.0.1:4000/design-toolkit/
### Compiling SCSS to CSS with Gulp or SASS CLI
1. To view, edit and complie `sass` to `css`:
a. For `gulp`: Make sure you have [Node.js](http://nodejs.org/) installed and up to date. From the root of the project run `npm i`. This will install the `gulp` dependencies.
- Once `gulp` is installed, from the root, run `gulp`. This will compile your `scss` files to `css` and place them in the correct directory.
- You can choose to run `gulp watch`, this command will actively watch the correct directory and complie files on save.
b. Alternately you can run / compile `sass` directly (no Gulp required), via its CLI.
- From the root of the project run: `sass --watch sass:css/docs`.
2. Have a milkshake. 🥛
## [Install the toolkit in your application](INSTALL.md)
## [View Change Log](CHANGELOG.md)
## License
See [LICENSE](LICENSE)