devkeeper-typedoc
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

devkeeper-typedoc

Typedoc commands for devkeeper

oclif Version Downloads/week License

Usage

$ npm install -g devkeeper-typedoc
$ devkeeper-typedoc COMMAND
running command...
$ devkeeper-typedoc (-v|--version|version)
devkeeper-typedoc/1.0.2 darwin-x64 node-v14.1.0
$ devkeeper-typedoc --help [COMMAND]
USAGE
  $ devkeeper-typedoc COMMAND
...

Commands

devkeeper-typedoc help [COMMAND]

display help for devkeeper-typedoc

USAGE
  $ devkeeper-typedoc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

devkeeper-typedoc html

Creates TypeDoc HTML files from TypeScript source files.

USAGE
  $ devkeeper-typedoc html

OPTIONS
  -h, --help  show CLI help
  --out=out   [default: api-docs-html] Output directory for generated HTML files.

See code: src/commands/html.ts

devkeeper-typedoc md

Creates TypeDoc markdown from TypeScript source files.

USAGE
  $ devkeeper-typedoc md

OPTIONS
  -h, --help    show CLI help

  --out=out     output directory or file for generated markdown. Default "api-docs-md" for multi files or "api.md" for
                single file

  --singleFile  combines all output into single markdown file

See code: src/commands/md.ts

Readme

Keywords

Package Sidebar

Install

npm i devkeeper-typedoc

Weekly Downloads

1

Version

1.0.2

License

MIT

Unpacked Size

15 kB

Total Files

23

Last publish

Collaborators

  • ozum