Skip to content

Commit

Permalink
Add info on switching to Sass; Remove unused dependencies; Style tweak
Browse files Browse the repository at this point in the history
Signed-off-by: mhkeller <code@mhkeller.com>
  • Loading branch information
mhkeller committed Dec 2, 2017
1 parent 6c297bf commit d1223fd
Show file tree
Hide file tree
Showing 6 changed files with 360 additions and 502 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,24 @@ rm -rf .git && git init

## What is this project?

This repository contains the code used to generate the [documentation for wsk](http://github.com/bloomberg/wsk). It also serves as an example repository for how to build out a complete wsk project. It uses the following technologies
This repository contains the code used to generate the [documentation for wsk](http://github.com/bloomberg/wsk). It also serves as an example repository for how to build out a complete wsk project. It uses the following libraries:

* [Underscore.js](https://underscorejs.org) for templating.
* [Rollup](https://rollupjs.org/) for JavaScript bundling.
* [Stylus](http://stylus-lang.com/) for CSS.
* [fs-extra](https://github.com/jprichardson/node-fs-extra) and Node's built-in `fs` for handling static files.

It also comes with a [node-sass](https://github.com/sass/node-sass) task file if you prefer that to Stylus. To switch, change the references to `stylus` in package.json under `build:css` and `dev:css` to `sass`:

* `"build:css": "node build/tasks/stylus/cli.js"``"build:css": "node build/tasks/sass/cli.js"`
* `"dev:css": "node build/tasks/sass/watch.js"``"dev:css": "node build/tasks/sass/watch.js"`

You can also remove the following Stylus dependencies from package.json:

* stylus
* rupture
* autoprefixer-stylus

## Tasks

Each of the tasks in `build/tasks/` has a `README.md` that explains its files and logic. They aim to be as consistent as possible according to the wsk architecture [described in the wsk `README.md`](http://bloomberg.github.io/wsk.docs#architecture) while accommodating the quirks of target libraries.
Expand Down
Loading

0 comments on commit d1223fd

Please sign in to comment.