Ts-docmagen NPM

Install

$ npm install -g ts-docmagen

Usage

$ ts-docmagen

Generate Docma (https://github.com/onury/docma) documentation from TypeScript
code annotated with JSDoc.

Options:
    --help        Show help                                          [boolean]
    --version     Show version number                                [boolean]
-s, --src         Source directory to read from            [string] [required]
-o, --out         Directory to output documentation to     [string] [required]
    --temp        The directory in which transpiled JavaScript is temporarily stored (auto-deleted by default)
                                                [string] [default: "docmagen"]
-d, --docma       Path to docma.json file
NOTE: If there is a docma.json file in the directory the command is called from, that file will be used by default
                                              [string] [default: "docma.json"]
    --no-purge-temp  Don't delete the temporarily generated JavaScript files after documentation has been generated
                                                    [boolean] [default: false]
    --no-docs     Don't generate Docma documentation (really only useful with --no-purge-temp)
                                                    [boolean] [default: false]
    --debug       Enable Docma debug output         [boolean] [default: false]
-a, --assets      List of globs to copy over as static assets
                                                         [array] [default: []]
    --ignore      Directories to ignore when generating documentation
                                                         [array] [default: []]

$ ts-docmagen --src ./src --out ./documentation
# Generates documentation in the 'documentation' 
# directory from the code in 'src'

$ ts-docmagen --src ./src --out ./documentation --assets ./assets/**/* --ignore node_modules
# Generates documentation in 'documentation' from 'src', 
# copying all files in 'assets' to the newly created documentation's 
# assets directory, and ignoring 'node_modules' when transpiling