Implement docs building

diff --git a/.gitignore b/.gitignore
index af5c7e2e9acbcb1343aee52c879ac3c84fb9ddda..029efd56b8536c4438a5a46baed01672599cc05a 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -8,5 +8,5 @@ Makefile.gyp
 *.target.gyp.mk
 *.node
 example/*.log
-docs/_build
+docs/
 npm-debug.log

diff --git a/conf.json b/conf.json
deleted file mode 100644 (file)
index b5c8e52..0000000
--- a/conf.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
-    "source": {
-        "include": [
-            "src/xterm.js",
-            "addons/attach/attach.js",
-            "addons/fit/fit.js",
-            "addons/fullscreen/fullscreen.js",
-            "addons/linkify/linkify.js"
-        ]
-    },
-    "opts": {
-        "readme": "README.md"
-    }
-}
\ No newline at end of file

diff --git a/jsdoc.json b/jsdoc.json
new file mode 100644 (file)
index 0000000..28ca16c
--- /dev/null
+++ b/jsdoc.json
@@ -0,0 +1,23 @@
+{
+  "source": {
+    "include": [
+      "src/xterm.js",
+      "addons/attach/attach.js",
+      "addons/fit/fit.js",
+      "addons/fullscreen/fullscreen.js",
+      "addons/linkify/linkify.js"
+    ]
+  },
+  "opts": {
+    "readme": "README.md",
+    "template": "node_modules/docdash",
+    "encoding": "utf8",
+    "destination": "docs/",
+    "recurse": true,
+    "verbose": true
+  },
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false
+  }
+}

diff --git a/package.json b/package.json
index f1d3e57741d9aad7a54956d43d2ca4bbf84c3fa9..1b98517c286ff8f23fa65dba84505183c0ad2a5a 100644 (file)
--- a/package.json
+++ b/package.json
@@ -10,10 +10,13 @@
     "express-ws": "2.0.0-rc.1",
     "pty.js": "0.3.0",
     "mocha": "2.5.3",
-    "chai": "3.5.0"
+    "chai": "3.5.0",
+    "jsdoc": "3.4.0",
+    "docdash": "0.4.0"
   },
   "scripts": {
     "start": "bash bin/server",
-    "test": "bash bin/test --recursive"
+    "test": "bash bin/test --recursive",
+    "build:docs": "node_modules/.bin/jsdoc -c jsdoc.json"
   }
 }