Configure jsdoc + fix package.json

diff --git a/.gitignore b/.gitignore
index 5148e527a7e286a1efcc44d65a7f8241267dce9b..88d9795c45cade429e5f9fa01bbee8bb40d6b0a3 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -35,3 +35,6 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
 
 # Optional REPL history
 .node_repl_history

+
+# Documentation
+doc

diff --git a/config/jsdoc.json b/config/jsdoc.json
new file mode 100644 (file)
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 c922b5668b8e285a6597ff8e6d28f2d97f321129..e9e53a6de70f73f229e0162939c1a99ec0a4a4b4 100644 (file)
--- a/package.json
+++ b/package.json
@@ -5,7 +5,7 @@
   "main": "index.js",
   "scripts": {
     "lint": "eslint .",
   "main": "index.js",
   "scripts": {
     "lint": "eslint .",

-    "document": "jsdoc ."
+    "document": "jsdoc ./js -c config/jsdoc.json",

     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {