@elliottsencan/easydocs

easydocs

A CLI to measure your code's documentation and generate a docs site

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"]
    }
    }

Usage

To generate a coverage report, run

• npm

  npm run generate-docs-coverage-report

To build a docs site, run

• npm

  npm run build-docs-site

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Elliott Sencan - [e-mail]

(back to top)