From: Ben Beltran Date: Thu, 10 Nov 2016 04:23:58 +0000 (-0600) Subject: Configure jsdoc + fix package.json X-Git-Url: https://git.r.bdr.sh/rbdr/heart/commitdiff_plain/6d2907fa68138d48a343200d10b6a400a2055566?ds=inline;hp=--cc Configure jsdoc + fix package.json --- 6d2907fa68138d48a343200d10b6a400a2055566 diff --git a/.gitignore b/.gitignore index 5148e52..88d9795 100644 --- a/.gitignore +++ b/.gitignore @@ -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": {