Merge pull request #129 from sourcelair/docs
Improve docs building script and template
This commit is contained in:
+1
-1
@@ -8,5 +8,5 @@ Makefile.gyp
|
|||||||
*.target.gyp.mk
|
*.target.gyp.mk
|
||||||
*.node
|
*.node
|
||||||
example/*.log
|
example/*.log
|
||||||
docs/_build
|
docs/
|
||||||
npm-debug.log
|
npm-debug.log
|
||||||
|
|||||||
@@ -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"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+23
@@ -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
|
||||||
|
}
|
||||||
|
}
|
||||||
+5
-2
@@ -10,10 +10,13 @@
|
|||||||
"express-ws": "2.0.0-rc.1",
|
"express-ws": "2.0.0-rc.1",
|
||||||
"pty.js": "0.3.0",
|
"pty.js": "0.3.0",
|
||||||
"mocha": "2.5.3",
|
"mocha": "2.5.3",
|
||||||
"chai": "3.5.0"
|
"chai": "3.5.0",
|
||||||
|
"jsdoc": "3.4.0",
|
||||||
|
"docdash": "0.4.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "bash bin/server",
|
"start": "bash bin/server",
|
||||||
"test": "bash bin/test --recursive"
|
"test": "bash bin/test --recursive",
|
||||||
|
"build:docs": "node_modules/.bin/jsdoc -c jsdoc.json"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user