grunt-literate - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

CHANGELOG.md

 ## Release History
 
+- 0.1.5 Maintenance release
+  - Updated dependencies
+  - Added note about beautiful docs
 - 0.1.4 Usage as executable and library
@@ -12,2 +15,2 @@ - run `ljs`
 - 0.1.1 Fix issue with unindenting
-- 0.1.0 Initial release
+- 0.1.0 Initial release

Gruntfile.js

@@ -38,2 +38,13 @@ /*
     },
+
+    bfdocs: {
+      documentation: {
+        options: {
+          title: "Grunt literate",
+          manifest: "bfdocs-manifest.json",
+          dest: "documentation/",
+          theme: "default",
+        }
+      }
+    },
   });
@@ -46,2 +57,3 @@
   grunt.loadNpmTasks("grunt-contrib-jshint");
+  grunt.loadNpmTasks("grunt-beautiful-docs");
 
@@ -48,0 +60,0 @@ // Whenever the "test" task is run, first clean the "tmp" dir, then run this

package.json

 {
   "name": "grunt-literate",
   "description": "Generate docs from your source",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "homepage": "https://github.com/phadej/grunt-literate",
@@ -32,7 +32,8 @@ "author": {
   "scripts": {
-    "test": "grunt test"
+    "test": "grunt"
   },
   "devDependencies": {
-    "grunt-contrib-jshint": "~0.7.1",
-    "grunt": "~0.4.1"
+    "grunt-contrib-jshint": "~0.8.0",
+    "grunt": "~0.4.1",
+    "grunt-beautiful-docs": "~0.1.0"
   },
@@ -47,3 +48,7 @@ "peerDependencies": {
     "programming",
-    "ljs"
+    "ljs",
+    "documentation",
+    "beautiful-docs",
+    "beaufiful",
+    "docs"
   ],
@@ -50,0 +55,0 @@ "dependencies": {

README.md

@@ -5,2 +5,3 @@ # grunt-literate
 
+[![Build Status](https://travis-ci.org/phadej/grunt-literate.png)](https://travis-ci.org/phadej/grunt-literate)
 [![Code Climate](https://codeclimate.com/github/phadej/grunt-literate.png)](https://codeclimate.com/github/phadej/grunt-literate)
@@ -80,2 +81,8 @@ [![NPM version](https://badge.fury.io/js/grunt-literate.png)](http://badge.fury.io/js/grunt-literate)
 
+## beautiful-docs
+
+This package plays well with [beautiful-docs](http://beautifuldocs.com/) and [grunt-beautiful-docs](https://www.npmjs.org/package/grunt-beautiful-docs) especially.
+
+Check [`Gruntfile.js`](https://github.com/phadej/grunt-literate/blob/master/Gruntfile.js) in the repository for an example.
+
 ## Contributing
@@ -90,2 +97,5 @@
 
+- 0.1.5 Maintenance release
+  - Updated dependencies
+  - Added note about beautiful docs
 - 0.1.4 Usage as executable and library
@@ -101,2 +111,3 @@ - run `ljs`
 - 0.1.0 Initial release
+
 ## Related work
@@ -103,0 +114,0 @@

tasks-literate-js.md

@@ -17,2 +17,3 @@
 
+[![Build Status](https://travis-ci.org/phadej/grunt-literate.png)](https://travis-ci.org/phadej/grunt-literate)
 [![Code Climate](https://codeclimate.com/github/phadej/grunt-literate.png)](https://codeclimate.com/github/phadej/grunt-literate)
@@ -415,2 +416,8 @@ [![NPM version](https://badge.fury.io/js/grunt-literate.png)](http://badge.fury.io/js/grunt-literate)
 
+## beautiful-docs
+
+This package plays well with [beautiful-docs](http://beautifuldocs.com/) and [grunt-beautiful-docs](https://www.npmjs.org/package/grunt-beautiful-docs) especially.
+
+Check [`Gruntfile.js`](https://github.com/phadej/grunt-literate/blob/master/Gruntfile.js) in the repository for an example.
+
 ## Contributing
@@ -425,2 +432,5 @@
 
+- 0.1.5 Maintenance release
+  - Updated dependencies
+  - Added note about beautiful docs
 - 0.1.4 Usage as executable and library
@@ -436,2 +446,3 @@ - run `ljs`
 - 0.1.0 Initial release
+
 ## Related work
@@ -438,0 +449,0 @@

tasks/literate.js

@@ -16,2 +16,3 @@ // vim: set sts=2 sw=2 ts=2 et:
 
+[![Build Status](https://travis-ci.org/phadej/grunt-literate.png)](https://travis-ci.org/phadej/grunt-literate)
 [![Code Climate](https://codeclimate.com/github/phadej/grunt-literate.png)](https://codeclimate.com/github/phadej/grunt-literate)
@@ -70,2 +71,3 @@ [![NPM version](https://badge.fury.io/js/grunt-literate.png)](http://badge.fury.io/js/grunt-literate)
 /// include ../bin/ljs.js
+/// plain ../beautiful-docs.md
 /// plain ../CONTRIBUTING.md
@@ -72,0 +74,0 @@ /// plain ../CHANGELOG.md

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

34200

increased by6.68%

Number of package files

17

increased by21.43%

Lines of code

408

increased by4.88%

Number of lines in readme file

147

increased by8.09%

Worsened metrics

Dev dependency count

3

increased by50%

No dependency changes