clean-jsdoc-theme - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "clean-jsdoc-theme",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Clean and minimal JSDoc 3 Template / Theme",
@@ -18,3 +18,6 @@ "main": "publish.js",
   },
-  "homepage": "https://github.com/ankitskvmdam/clean-jsdoc-theme#readme"
+  "homepage": "https://github.com/ankitskvmdam/clean-jsdoc-theme#readme",
+  "dependencies": {
+    "jsdoc": "^3.6.3"
+  }
 }

README.md

 # clean-jsdoc-theme
-Clean and minimal JSDoc 3 Template / Theme
+A clean, responsive template / theme for JSDoc 3. This is created for those who love design.
+
+## Install
+> Note you must have `npm` installed on your machine.
+
+On your command line type
+```bash
+npm install clean-jsdoc-theme
+```
+
+## Usage
+Clone repository to your designated jsdoc template directory, then
+
+```bash
+jsdoc entry-file.js -t path/to/clean-jsdoc-theme
+```
+## Node.js Dependency
+In your projects package.json file add a generate script
+```json
+"script": {
+  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
+}
+```
+
+In your `jsdoc.json` file, add a template option.
+
+```json
+"opts": {
+  "template": "node_modules/clean-jsdoc-theme"
+}
+```
+
+
+## Example JSDoc Config
+```json
+{
+    "source": {
+        "include": ["lib", "package.json", "README.md"],
+        "includePattern": ".js$",
+        "excludePattern": "(node_modules/|docs)"
+    },
+
+    "plugins": [
+        "plugins/markdown"
+    ],
+
+    "opts": {
+        "encoding": "utf8",
+        "readme": "./README.md",
+        "destination": "docs/",
+        "recurse": true,
+        "verbose": true,
+        "template": "./node_modules/clean-jsdoc-theme"
+    }
+}
+```
+
+## 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

384574

increased by0.31%

Number of lines in readme file

60

increased by1900%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedjsdoc@^3.6.3

• + Added@babel/helper-string-parser@7.24.8(transitive)

• + Added@babel/helper-validator-identifier@7.24.7(transitive)

• + Added@babel/parser@7.25.6(transitive)

• + Added@babel/types@7.25.6(transitive)

• + Added@types/linkify-it@5.0.0(transitive)

• + Added@types/markdown-it@12.2.3(transitive)

• + Added@types/mdurl@2.0.0(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addedbluebird@3.7.2(transitive)

• + Addedcatharsis@0.9.0(transitive)

• + Addedentities@2.1.0(transitive)

• + Addedescape-string-regexp@2.0.0(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedjs2xmlparser@4.0.2(transitive)

• + Addedjsdoc@3.6.11(transitive)

• + Addedklaw@3.0.0(transitive)

• + Addedlinkify-it@3.0.3(transitive)

• + Addedlodash@4.17.21(transitive)

• + Addedmarkdown-it@12.3.2(transitive)

• + Addedmarkdown-it-anchor@8.6.7(transitive)

• + Addedmarked@4.3.0(transitive)

• + Addedmdurl@1.0.1(transitive)

• + Addedmkdirp@1.0.4(transitive)

• + Addedrequizzle@0.2.4(transitive)

• + Addedstrip-json-comments@3.1.1(transitive)

• + Addedtaffydb@2.6.2(transitive)

• + Addedto-fast-properties@2.0.0(transitive)

• + Addeduc.micro@1.0.6(transitive)

• + Addedunderscore@1.13.7(transitive)

• + Addedxmlcreate@2.0.4(transitive)