From 136d97dca297f22fa88848477b17f2c8dde3903c Mon Sep 17 00:00:00 2001 From: Tim Heap Date: Fri, 24 Apr 2015 08:52:36 +1000 Subject: [PATCH] Add instructions on compiling SCSS files to docs --- docs/contributing/css_guidelines.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/contributing/css_guidelines.rst b/docs/contributing/css_guidelines.rst index 26d1e5e123..fef75dfc4a 100644 --- a/docs/contributing/css_guidelines.rst +++ b/docs/contributing/css_guidelines.rst @@ -3,6 +3,26 @@ CSS coding guidelines Our CSS is written in Sass, using the SCSS syntax. +Compiling +~~~~~~~~~ + +The SCSS source files are compiled to CSS using the +[gulp](http://gulpjs.com/) build system. +This requires [node.js](http://nodejs.org) to run. +To install the libraries required for compiling the SCSS, +run the following from the Wagtail repository root: + + $ npm install + +To compile the assets, run: + + $ npm run build + +Alternatively, the SCSS files can be monitored, +automatically recompiling when any changes are observed, by running: + + $ npm start + Spacing ~~~~~~~