@elliottsencan/easydocs NPM

Getting Started

Use easydocs on any npm package!

Prerequisites

npm
```
npm install easy-docs -g
```

then add the following to your package.json

npm

  "scripts": {
      "generate-docs-coverage-report": "easydocs-coverage-report",
      "build-docs-site": "easydocs-build-docs",
  }

and add a configuration file called ".easydocsconfig.json"

npm

{
  "build": {
    "source": "./js/src",
    "target": "./docs"
  },
  "meta": {
    "docsDescription": "Test Description",
    "docsName": "Easy Docs",
    "github": "https://www.github.com",
    "author": "Elliott Sencan"
  },
  "coverage": {
    "required": ["FunctionDeclaration"]
  }
  }