clean-jsdoc-theme - npm Package Compare versions

Comparing version 1.0.1 to 2.0.0

package.json

 {
   "name": "clean-jsdoc-theme",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Clean and minimal JSDoc 3 Template / Theme",
@@ -21,3 +21,13 @@ "main": "publish.js",
     "jsdoc": "^3.6.3"
-  }
+  },
+  "keywords": [
+    "jsdoc",
+    "template",
+    "theme",
+    "jsdoc template",
+    "jsdoc theme",
+    "jsdoc-template",
+    "jsdoc-theme",
+    "javascript documentation"
+  ]
 }

publish.js

@@ -351,4 +351,4 @@ /*global env: true */
 function buildNav(members) {
-    var pkgVersion = env.opts && env.opts.query && env.opts.query.pkgVersion;
-    var nav = '<h2><a href="index.html">Home' + (pkgVersion ? (' ' + pkgVersion) : '') + '</a></h2>';
+    var title = env.opts.theme_opts.title || "Home"
+    var nav = '<h2><a href="index.html">'+title+'</a></h2>'
     var seen = {};
@@ -381,3 +381,3 @@ var seenTutorials = {};
         else {
-            nav += '<h3>Global</h3><ul>' + globalNav + '</ul>';
+            nav += '<h3>'+ linkto('global', 'Global') +'</h3><ul>' + globalNav + '</ul>';
         }
@@ -389,2 +389,7 @@ }
 
+function buildFooter(){
+    var footer = env.opts.theme_opts.footer || ""
+    return footer
+}
+
 /**
@@ -573,2 +578,3 @@ @param {TAFFY} taffyData See <http://taffydb.com/>.
     view.outputSourceFiles = outputSourceFiles;
+    view.footer = buildFooter();
 
@@ -575,0 +581,0 @@ // once for all

README.md

 # clean-jsdoc-theme
 A clean, responsive template / theme for JSDoc 3. This is created for those who love design.
+### Demo screen
+![Home](./example/home.png)
+![Global](./example/global.png)
+![code](./example/code.png)
 
@@ -18,2 +22,3 @@ ## Install
 ```
+
 ## Node.js Dependency
@@ -60,3 +65,22 @@ In your projects package.json file add a generate script
 
+## Features
+You can pass an object called `theme_opts` under `opts` for more options like:
+```javascript
+"opts":{
+  /*
+    Default options
+  */
+  "theme_opts":{
+    "title": "Navbar Title", 
+    /* 
+      Instead of only string you can pass html element like <img src="src to your img" style=""/>
+      Path must be absolute not relative to this config file.
+    */
+
+    "footer": "This is footer",   // Here again you can pass html element 
+  }
+}
+```
+
 ## License
 Licensed under the MIT license.

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

901845

increased by134.5%

Number of package files

36

increased by16.13%

Lines of code

1628

increased by4.76%

Number of lines in readme file

84

increased by40%

No dependency changes