diff options
| author | Ben Beltran <ben@nsovocal.com> | 2016-11-09 22:23:58 -0600 |
|---|---|---|
| committer | Ben Beltran <ben@nsovocal.com> | 2016-11-09 22:23:58 -0600 |
| commit | 6d2907fa68138d48a343200d10b6a400a2055566 (patch) | |
| tree | 6d5c1fc1214b892edb8f02f38e636931e24c48ef | |
| parent | 9e573a932f91a052c11db51adde546b886043daa (diff) | |
Configure jsdoc + fix package.json
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | config/jsdoc.json | 9 | ||||
| -rw-r--r-- | package.json | 2 |
3 files changed, 13 insertions, 1 deletions
@@ -35,3 +35,6 @@ jspm_packages # Optional REPL history .node_repl_history + +# Documentation +doc diff --git a/config/jsdoc.json b/config/jsdoc.json new file mode 100644 index 0000000..9e05753 --- /dev/null +++ b/config/jsdoc.json @@ -0,0 +1,9 @@ +{ + "plugins": ["plugins/markdown"], + "opts": { + "destination": "doc", + "readme": "README.md", + "template": "node_modules/docdash", + "recurse": true + } +} diff --git a/package.json b/package.json index c922b56..e9e53a6 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "index.js", "scripts": { "lint": "eslint .", - "document": "jsdoc ." + "document": "jsdoc ./js -c config/jsdoc.json", "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { |