api-documenter

Markdown documentation generator for typescript based on @microsoft/api-documenter.

Example

Installation

yarn add @josselinbuils/api-documenter
npm install @josselinbuils/api-documenter

Usage

Usage: api-documenter [options]

Options:
  -V, --version                 output the version number
  -i, --input-file <file>       entry .d.ts file. Default value: dist/index.d.ts.
  -o, --output-folder <folder>  folder where the documentation will be written. /!\ Everything in this folder will be deleted! Default value: doc.
  -h, --help                    output usage information