command-line-docs
Generate markdown documentation based on your command-line-application command definitions
Installation
npm i -D command-line-docs# or yarn add -D command-line-docs
Usage
This package support both the Command
and MultiCommand
from command-line-application.
;; const echo: Command = name: 'echo' description: 'Print a string to the terminal' options: name: 'value' type: String defaultOption: true description: 'The value to print' ; console;
This will output:
# `echo` Print a string to the terminal ## Options | Flag | Type | Description || ----------- | ------ | ------------------ || \`--value\` | String | The value to print |
Options
Depth
Control the header depth.
// Now the docs will start with an h2 instead of an h1;
Including global options with each sub-command
You might want to include the global options in each sub-command's options table. To do this use the includeGlobalOptionsForSubCommands
option.
;