https://github.com/ozum/devkeeper-typedoc
TypeDoc commands and API for devkeeper.
https://github.com/ozum/devkeeper-typedoc
Last synced: about 2 months ago
JSON representation
TypeDoc commands and API for devkeeper.
- Host: GitHub
- URL: https://github.com/ozum/devkeeper-typedoc
- Owner: ozum
- Created: 2020-05-15T16:23:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T06:05:58.000Z (over 2 years ago)
- Last Synced: 2025-03-11T07:40:47.648Z (2 months ago)
- Language: TypeScript
- Size: 3.42 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
devkeeper-typedoc
=================
Typedoc commands for devkeeper
[](https://oclif.io)
[](https://npmjs.org/package/devkeeper-typedoc)
[](https://npmjs.org/package/devkeeper-typedoc)
[](https://github.com/ozum/devkeeper-typedoc/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ 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]`](#devkeeper-typedoc-help-command)
* [`devkeeper-typedoc html`](#devkeeper-typedoc-html)
* [`devkeeper-typedoc md`](#devkeeper-typedoc-md)
## `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](https://github.com/oclif/plugin-help/blob/v3.0.1/src/commands/help.ts)_
## `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](https://github.com/ozum/devkeeper-typedoc/blob/v1.0.2/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](https://github.com/ozum/devkeeper-typedoc/blob/v1.0.2/src/commands/md.ts)_