Closed
Description
Issue Summary
Creating local documentation can be super helpful
- Force a version of chai and install esdoc and coverage plugin
npm i chai@2.3.0 esdoc esdoc-coverage-plugin
- In the root dir, create .esdoc.json with the following:
{
"source": "./lib",
"destination": "./docs",
"plugins": [
{
"name": "esdoc-coverage-plugin",
"option": {
"enable": true,
"kind": ["class", "method", "member", "get", "set", "constructor", "function", "variable"]
}
}
]
}
- Update .gitignore by adding
docs
to the list of files to ignore - Look at this PR and make the same changes to the files here in smtpapi-nodejs as were made to CONTRIBUTING and USAGE in sendgrid-nodejs
Metadata
Metadata
Assignees
Labels
No labels