diff --git a/jsdoc.conf.json b/jsdoc.conf.json new file mode 100644 index 0000000..5a55bba --- /dev/null +++ b/jsdoc.conf.json @@ -0,0 +1,17 @@ +{ + "plugins": ["plugins/markdown.js"], + "opts": { + "template": "node_modules/docdash", + "encoding": "utf8", + "destination": "./docs" + }, + "docdash": { + "static": true, + "sort": true, + "search": true, + "collapse": true, + "typedefs": false, + "removeQuotes": "none", + "scripts": [] + } +} diff --git a/package.json b/package.json index dd58442..428f6a5 100644 --- a/package.json +++ b/package.json @@ -14,11 +14,14 @@ "test": "npm run test:node && npm run test:browser", "test:node": "mocha", "test:browser": "karma start --single-run --browsers ChromeHeadless,FirefoxHeadless karma.config.js", + "docs": "jsdoc -c ./jsdoc.conf.json --package ./package.json .", "build": "webpack" }, "author": "", "license": "ISC", "devDependencies": { + "jsdoc": "^3.6.10", + "docdash": "^1.2.0", "chai": "^4.3.4", "chai-as-promised": "^7.1.1", "karma": "^6.3.9",