Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.69 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.69 KB

swarm-sasstools

npm version Build Status

Documentation

https://meetup.github.io/swarm-sasstools/

Build

Sass is compiled via webpack. Grunt is used in this project as a task runner to build documentation from compiled CSS.

Scripts

Script Result
yarn run build Runs default grunt task.

Grunt tasks

Run build tasks with yarn grunt [command].

Command Result
[default] Cleans built docs, compiles Sass via webpack, generates sassdoc and seldon docs
serve Starts browsersync on localhost:3000; will watch for source changes (may require manual browser refresh for now)
ghpages Caution: automatically commits compiled docs in docs/build/ to the gh-pages branch

★ in the event browsersync throws a permissions error, chown node_modules/

Releases

This package uses semver versioning to tag releases, although the patch version is determined exclusively by the Travis build number for pushes to master. Major and minor versions are hard-coded into the Makefile.

Manual pushes to master and PR merges to master will be built by Travis, and will kick off the yarn publish routine. The currently-published version of the package is shown on the repo homepage on GitHub in a badge at the top of the README.