Documentation generate scripts

This commit is contained in:
Michal Szczepanski 2019-07-23 01:19:17 +02:00
parent 5cff7ee4c0
commit 81f4de1c29
4 changed files with 18 additions and 1 deletions

8
.esdoc.json Normal file

@ -0,0 +1,8 @@
{
"source": "./src",
"destination": "./docs",
"plugins": [
{"name": "esdoc-standard-plugin"},
{"name": "esdoc-node"}
]
}

1
.gitignore vendored

@ -3,6 +3,7 @@
# node # node
node_modules node_modules
docs
yarn.lock yarn.lock
# ide # ide

@ -12,5 +12,13 @@
}, },
"bin": { "bin": {
"pdfdig": "./bin/pdfdig" "pdfdig": "./bin/pdfdig"
},
"scripts": {
"doc": "esdoc"
},
"devDependencies": {
"esdoc": "^1.1.0",
"esdoc-node": "^1.0.4",
"esdoc-standard-plugin": "^1.0.0"
} }
} }

@ -71,7 +71,7 @@ class GoldDigger {
/** /**
* Process page * Process page
* @param doc - pdf document * @param page - pdf page
* @param pageNum - page number * @param pageNum - page number
*/ */
async digPage(page, pageNum) { async digPage(page, pageNum) {