Document build_css.js

lib/build_css.js

@@ -4,6 +4,22 @@ const join = require('path').join
 const readFileSync = require('fs').readFileSync
 const dirname = require('path').dirname
 
+/*
+ * Builds the CSS files.
+ *
+ * This builds the CSS using Stylus and pipes it through postcss. It's roughly
+ * equivalent to:
+ *
+ *     stylus -I node_modules input.css | postcss -u autoprefixer
+ *
+ * Calls `done(err, res)` when done, where `res` is the final CSS string.
+ *
+ * Available options:
+ *
+ * - `compress` (Boolean) - compresses if true
+ * - `import` (Array of strings) - adds files to be imported
+ */
+
 module.exports = function buildCss (options, done) {
   buildStylus(join(__dirname, '../css/docpress.styl'), options, done)
 }