Skip to content

Latest commit

 

History

History

docgen

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 



About

@reciple/docgen parses Typescript files to generate json file for documentation

Usage

reciple-docgen -i ./src/index.ts -c ./docs/custom.json -o ./docs/docs.json
Usage: reciple-docgen [options]

Options:
  -V, --version            output the version number
  -i, --input <string...>  Source files to parse docs in
  -c, --custom [string]    Custom docs pages file to use
  -r, --root [string]      Project root directory (default: ".")
  --readme [string]        README.md path location (default: "README.md")
  -o, --output <string>    Path to output file
  -p, --pretty             Pretty print JSON output
  -h, --help               display help for command