markdown-styleguide-generator - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

package.json

 {
   "name": "markdown-styleguide-generator",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Will search all your (s)css files for markdown and generate a single page html styleguide",
@@ -24,3 +24,3 @@ "main": "index.js",
   "dependencies": {
-    "chalk": "^0.5.1",
+    "chalk": "^1.0.0",
     "cheerio": "^0.18.0",
@@ -27,0 +27,0 @@ "fs-extra": "^0.16.3",

README.md

@@ -268,1 +268,23 @@ # markdown-styleguide-generator
 ```
+
+## Run with gulp/grunt
+If you want to re-create the styleguide automagicalle every time a stylesheet file is changed, you can run it with your favorite task runner. One way of running it with gulp would be using gulp-shell to execute the shell command `styleguide` when a file is changed.
+
+Sample gulp script:
+```
+var gulp  = require('gulp');
+var shell = require('gulp-shell');
+var watch = require('gulp-watch');
+
+gulp.task('watch', function() {
+  gulp.watch('path/to/watch/for/changes/**/*.scss', ['makeStyleguide']);
+});
+
+gulp.task('makeStyleguide',
+  shell.task(
+    ['styleguide']
+  )
+);
+
+gulp.task('default', ['watch']);
+```

No alert changes

Improved metrics

Number of lines in readme file

290

increased by8.21%

Worsened metrics

Total package byte prevSize

264292

decreased by-7.96%

Number of package files

9

decreased by-52.63%

Dependency changes

• + Addedansi-regex@2.1.1(transitive)

• + Addedansi-styles@2.2.1(transitive)

• + Addedchalk@1.1.3(transitive)

• + Addedhas-ansi@2.0.0(transitive)

• + Addedstrip-ansi@3.0.1(transitive)

• + Addedsupports-color@2.0.0(transitive)

• - Removedansi-regex@0.2.1(transitive)

• - Removedansi-styles@1.1.0(transitive)

• - Removedchalk@0.5.1(transitive)

• - Removedhas-ansi@0.1.0(transitive)

• - Removedstrip-ansi@0.3.0(transitive)

• - Removedsupports-color@0.2.0(transitive)

• Updatedchalk@^1.0.0