minimal-jsdoc - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

package.json

 {
   "name": "minimal-jsdoc",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Minimal template for JSDoc 3",
@@ -5,0 +5,0 @@ "main": "Gruntfile.js",

publish.js

@@ -451,8 +451,2 @@ /*global env: true */
 
-    generate('Index',
-        packages.concat(
-            [{kind: 'mainpage', readme: opts.readme, longname: (opts.mainpagetitle) ? opts.mainpagetitle : 'Main Page'}]
-        ).concat(files),
-    indexUrl);
-
     // set up the lists that we'll use to generate pages
@@ -479,3 +473,4 @@ var classes = taffy(members.classes);
             if (myNamespaces.length) {
-                generate('Namespace: ' + myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]);
+                myNamespaces = [{readme: opts.readme}].concat(myNamespaces);
+                generate('Namespace: ' + myNamespaces[0].name, myNamespaces, 'index.html');
             }
@@ -522,1 +517,2 @@
 };
+

README.md

@@ -1,2 +0,2 @@
-Minimal template for JSDoc 3
+Minimal template for JSDoc 3 (Beta)
 ---
@@ -7,6 +7,4 @@ A minimal template for creating clean documentation for one-namespace libraries.
 
-Currently, I need to fix a bug where index.html is blank. For now, you will need to visit YOURNAMESPACE.html for your documentation.
+This is still a beta and hasn't been heavily field tested. The code is pretty dirty right now due to pure laziness. This should only be used if your library contains one name-space. Not sure what would happen if you added more that one. Haha.
 
-This is still a beta and hasn't been heavily field tested.
-
 Usage
@@ -20,3 +18,3 @@ ---
 ```
-$ jsdoc -t .node_modules/minimal-jsdoc -c `configuration file` `source files` `README.md file`
+$ jsdoc -t .node_modules/minimal-jsdoc -c `configuration file` `source files` --readme `README.md file`
 ```
@@ -23,0 +21,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

616196

decreased by-1.4%

Number of package files

45

decreased by-10%

Lines of code

1817

decreased by-0.38%

Number of lines in readme file

54

decreased by-3.57%

No dependency changes