grunt-sassdoc - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

package.json

 {
   "name": "grunt-sassdoc",
   "title": "grunt-sassdoc",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "SassDoc grunt task",
@@ -27,3 +27,3 @@ "keywords": [
     "lodash": "^2.4.1",
-    "sassdoc": "^1.0.0-rc.8"
+    "sassdoc": "1.0.0-rc.10"
   },
@@ -30,0 +30,0 @@ "devDependencies": {

readme.md

@@ -1,2 +0,2 @@
-# grunt-sassdoc [![npm version](http://img.shields.io/npm/v/grunt-sassdoc.svg?style=flat)](https://www.npmjs.org/package/grunt-sassdoc) [![Build Status: Linux](http://img.shields.io/travis/pascalduez/grunt-sassdoc.svg?style=flat)](https://travis-ci.org/pascalduez/grunt-sassdoc.svg?branch=master)
+# grunt-sassdoc [![npm version](http://img.shields.io/npm/v/grunt-sassdoc.svg?style=flat)](https://www.npmjs.org/package/grunt-sassdoc) [![Build Status: Linux](http://img.shields.io/travis/pascalduez/grunt-sassdoc.svg?style=flat)](https://travis-ci.org/pascalduez/grunt-sassdoc?branch=master)
 
@@ -52,18 +52,4 @@ > [SassDoc](https://github.com/HugoGiraudel/SassDoc) grunt task.
 
-#### title
+#### display.access
 
-Type: `String`  
-Default: `'SassDoc'`
-
-Generated documentation page title.
-
-#### version
-
-Type: `String | false`  
-Default: `null`
-
-Whether to display project version next to the page title.
-
-#### display_access
-
 Type: `Array`  
@@ -74,3 +60,3 @@ Default: `['public', 'private']`
 
-#### display_alias
+#### display.alias
 
@@ -82,2 +68,28 @@ Type: `Boolean`
 
+
+#### display.watermark
+
+Type: `Boolean`  
+Default: `false`
+
+Enable/disable display of SassDoc watermark in footer.
+
+
+### package
+
+Type: `String | Object`  
+Default: `'./package.json'`
+
+Pass your project informations to the generated view.
+Either a path to your `package.json` or an object.
+
+Following keys will be looked for:
+`name`
+`version`
+`license`
+`homepage`
+`description`
+
+
+
 _**Heads up**: If a config file is passed and found, its options will prevail over defauts.
@@ -114,6 +126,8 @@ Additionnal options passed to the grunt task, will complement it but not override it.
       options: {
-        title: 'My cool project'
-        version: 'v1.5.0'
-        display_access: ['public'],
-        display_alias: true
+        display: {
+          access: ['public', 'private'],
+          alias: true,
+          watermark: true
+        },
+        package: './package.json'
       }
@@ -120,0 +134,0 @@ }

tasks/sassdoc.js

@@ -42,9 +42,10 @@ /*
       config: null,
-      title: 'SassDoc',
-      version: null,
-      display_access: ['public', 'private'],
-      display_alias: false
+      display: {
+        access: ['public', 'private'],
+        alias: false,
+        watermark: true
+      },
+      package: null
     });
 
-
     // If a config file is passed and found,
@@ -51,0 +52,0 @@ // its options will prevail over defauts.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7516

increased by2.99%

Lines of code

68

increased by3.03%

Number of lines in readme file

143

increased by10.85%

Dependency changes

• + Addedcdocparser@0.0.10(transitive)

• + Addeddocopt@0.4.1(transitive)

• + Addedncp@0.5.1(transitive)

• + Addedsassdoc@1.0.0-rc.10(transitive)

• + Addedscsscommentparser@0.0.16(transitive)

• + Addedswig@1.3.2(transitive)

• - Removedansi-regex@2.1.1(transitive)

• - Removedap@0.2.0(transitive)

• - Removedargparse@1.0.10(transitive)

• - Removedcdocparser@0.4.0(transitive)

• - Removedconfigstore@0.3.2(transitive)

• - Removedcore-util-is@1.0.3(transitive)

• - Removeddeep-extend@0.6.0(transitive)

• - Removeddocopt@0.6.2(transitive)

• - Removedduplexify@3.7.1(transitive)

• - Removedend-of-stream@1.4.4(transitive)

• - Removedesprima@4.0.1(transitive)

• - Removedextend@1.3.03.0.2(transitive)

• - Removedfdocopt@0.1.3(transitive)

• - Removedfs-extra@0.30.0(transitive)

• - Removedgot@3.3.1(transitive)

• - Removedgraceful-fs@3.0.124.2.11(transitive)

• - Removedinfinity-agent@2.0.3(transitive)

• - Removedini@1.3.8(transitive)

• - Removedis-npm@1.0.0(transitive)

• - Removedis-redirect@1.0.0(transitive)

• - Removedis-stream@1.1.0(transitive)

• - Removedisarray@1.0.0(transitive)

• - Removedjs-yaml@3.14.1(transitive)

• - Removedjsonfile@2.4.0(transitive)

• - Removedklaw@1.3.1(transitive)

• - Removedlatest-version@1.0.1(transitive)

• - Removedlodash._basebind@2.4.1(transitive)

• - Removedlodash._basecreate@2.4.1(transitive)

• - Removedlodash._basecreatecallback@2.4.1(transitive)

• - Removedlodash._basecreatewrapper@2.4.1(transitive)

• - Removedlodash._createwrapper@2.4.1(transitive)

• - Removedlodash._isnative@2.4.1(transitive)

• - Removedlodash._objecttypes@2.4.1(transitive)

• - Removedlodash._setbinddata@2.4.1(transitive)

• - Removedlodash._shimkeys@2.4.1(transitive)

• - Removedlodash._slice@2.4.1(transitive)

• - Removedlodash.assign@2.4.1(transitive)

• - Removedlodash.bind@2.4.1(transitive)

• - Removedlodash.foreach@2.4.1(transitive)

• - Removedlodash.forown@2.4.1(transitive)

• - Removedlodash.identity@2.4.1(transitive)

• - Removedlodash.isfunction@2.4.1(transitive)

• - Removedlodash.isobject@2.4.1(transitive)

• - Removedlodash.keys@2.4.1(transitive)

• - Removedlodash.noop@2.4.1(transitive)

• - Removedlodash.support@2.4.1(transitive)

• - Removedlowercase-keys@1.0.1(transitive)

• - Removedmarked@0.3.19(transitive)

• - Removedminimist@1.2.8(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removednatives@1.1.6(transitive)

• - Removednested-error-stacks@1.0.2(transitive)

• - Removedobject-assign@2.1.13.0.0(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedos-homedir@1.0.2(transitive)

• - Removedos-tmpdir@1.0.2(transitive)

• - Removedosenv@0.1.5(transitive)

• - Removedpackage-json@1.2.0(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedpinkie@2.0.4(transitive)

• - Removedpinkie-promise@2.0.1(transitive)

• - Removedprepend-http@1.0.4(transitive)

• - Removedprocess-nextick-args@2.0.1(transitive)

• - Removedrc@1.2.8(transitive)

• - Removedread-all-stream@3.1.0(transitive)

• - Removedreadable-stream@2.3.8(transitive)

• - Removedregistry-url@3.1.0(transitive)

• - Removedsafe-buffer@5.1.2(transitive)

• - Removedsafe-wipe@0.2.5(transitive)

• - Removedsassdoc@1.10.12(transitive)

• - Removedsassdoc-extras@1.0.3(transitive)

• - Removedsassdoc-theme-default@1.7.4(transitive)

• - Removedscss-comment-parser@0.5.0(transitive)

• - Removedsemver@3.0.15.7.2(transitive)

• - Removedsemver-diff@2.1.0(transitive)

• - Removedsemver-regex@1.0.0(transitive)

• - Removedsprintf-js@1.0.3(transitive)

• - Removedstream-shift@1.0.3(transitive)

• - Removedstring-length@1.0.1(transitive)

• - Removedstring_decoder@1.1.1(transitive)

• - Removedstrip-ansi@3.0.1(transitive)

• - Removedstrip-indent@0.1.3(transitive)

• - Removedstrip-json-comments@2.0.1(transitive)

• - Removedswig@1.4.0(transitive)

• - Removedthemeleon@0.2.11.0.4(transitive)

• - Removedthemeleon-swig@0.2.1(transitive)

• - Removedtimed-out@2.0.0(transitive)

• - Removedupdate-notifier@0.2.2(transitive)

• - Removeduser-home@1.1.1(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removeduuid@2.0.3(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedxdg-basedir@1.0.1(transitive)

• Updatedsassdoc@1.0.0-rc.10