sassdoc - npm Package Compare versions

Comparing version 0.3.9 to 0.4.0

package.json

@@ -5,3 +5,3 @@ {
   "author": "Hugo Giraudel",
-  "version": "0.3.9",
+  "version": "0.4.0",
   "license": "MIT",
@@ -8,0 +8,0 @@ "repository": {

README.md

@@ -32,3 +32,2 @@ # SassDoc
 
-
 ### Variable
@@ -73,2 +72,3 @@
 * `-v, --verbose`: run in verbose mode
+* `-c, --config`: path to `.json` file containing variables to be passed to the view
 
@@ -355,2 +355,12 @@ ### Node API
 
+## Pass extra variables to the view
+
+With the `-c` or `--config` flag, you can set the path to a JSON file containing variables to be passed to the view so the latter is a little more customized than the default documentation. 
+
+Default path leads to the `view.json` file at root level. You can update this file or make your own.
+
+Allowed variables:
+
+* `title`
+
 ## Credits
@@ -357,0 +367,0 @@

src/api.js

@@ -14,3 +14,3 @@ 'use strict';
    */
-  documentize: function (source, destination) {
+  documentize: function (source, destination, config) {
     fs.folder.refresh(destination)
@@ -23,3 +23,3 @@ .then(function () {
         logger.log('Folder `' + source + '` successfully parsed.');
-        return fs.generate(data, destination + '/index.html');
+        return fs.generate(data, destination + '/index.html', config);
       })
@@ -26,0 +26,0 @@ .then(function () {

src/file.js

@@ -198,7 +198,10 @@ 'use strict';
    * @param {String} destination
+   * @param {Object} options
    */
-  generate: function (data, destination) {
+  generate: function (data, destination, options) {
     var template = swig.compileFile(__dirname + '/../templates/docs.html.swig');
+
+    options.data = data;
     
-    return exports.file.create(destination, template({ 'data': data }));
+    return exports.file.create(destination, template(options));
   },
@@ -205,0 +208,0 @@

src/parser.js

@@ -156,3 +156,3 @@ 'use strict';
       if (tmp) {
-        doc.links.push({ 'url': tmp[1], 'caption': tmp[2] })
+        doc.links.push({ 'url': tmp[1], 'caption': tmp[2] });
       }
@@ -195,3 +195,3 @@ });
 
-        if (typeof item.access === "undefined") {
+        if (typeof item.access === 'undefined') {
           item.access = isVariable[3] === '!global' ? 'public' : 'private';
@@ -198,0 +198,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

143548

increased by0.62%

Number of package files

61

increased by5.17%

Lines of code

1362

increased by0.74%

Number of lines in readme file

366

increased by2.81%

No dependency changes