Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 695 Bytes

README.md

File metadata and controls

25 lines (18 loc) · 695 Bytes

Akveo Parser Documentation Tool

This tool helps us in creating incredible documentation for our projects!

Usage: prsr [options]

Options:

  • -h, --help output usage information
  • -V, --version output the version number
  • -g, --generator Generator:
  • -f, --framework Framework:
  • -i, --input Path to input file:
  • -o, --output Path to output file:

You have to specify:

  • generator (can be 2 types: typedoc, docjs)
  • framework (can be 2 types: angular, react)
  • pathes to input and output file (output file will be created)

For example:

prsr -g typedoc -f angular -i input.json -o output.json