Skip to content

Commit

Permalink
docs(esdoc): Add ESDoc documentation generator
Browse files Browse the repository at this point in the history
  • Loading branch information
VovanR committed Apr 8, 2019
1 parent 12735e0 commit 9ff2154
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
9 changes: 9 additions & 0 deletions .esdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"source": "./src",
"destination": "./docs",
"plugins": [
{
"name": "esdoc-standard-plugin"
}
]
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ node_modules
coverage
.nyc_output
npm-debug.log
docs
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@
"node": ">=6"
},
"scripts": {
"build": "cross-env NODE_ENV=production webpack -p",
"start": "webpack --watch",
"test": "xo && nyc ava",
"tdd": "ava -w",
"release-patch": "mversion patch",
"release-minor": "mversion minor",
"release-major": "mversion major",
"deploy": "npm run build && gh-pages -d example"
"deploy": "npm run docs && gh-pages -d docs",
"docs": "esdoc"
},
"files": [
"index.js"
Expand All @@ -31,6 +30,8 @@
"coveralls": "^3.0.3",
"cross-env": "^5.2.0",
"cz-conventional-changelog": "^2.1.0",
"esdoc": "^1.1.0",
"esdoc-standard-plugin": "^1.0.0",
"esm": "^3.2.22",
"gh-pages": "^2.0.1",
"husky": "^1.3.1",
Expand Down

0 comments on commit 9ff2154

Please sign in to comment.