Skip to content

Add esdoc support #50

Closed
Closed
@mbernier

Description

@mbernier

Issue Summary

Creating local documentation can be super helpful

  1. Force a version of chai and install esdoc and coverage plugin
npm i chai@2.3.0 esdoc esdoc-coverage-plugin
  1. 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"]
        }
      }
    ]
  }
  1. Update .gitignore by adding docs to the list of files to ignore
  2. 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

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions