Skip to Main content

tuyen dev doc

Generate HTML documentation for a CLI program from its --help output

Usage

tuyen dev doc [OPTIONS] --program <PROGRAM>

Options

-p, --program <PROGRAM>

Name of the CLI program to generate docs for

--front-matter

Include YAML front matter in the generated HTML files
Default values: false
Possible values: true, false

--no-title

Omit the command title heading from each generated page
Default values: false
Possible values: true, false

--hidden

Mark the generated files as hidden in the front matter
Default values: false
Possible values: true, false

-c, --command <COMMAND>

Comma-separated list of subcommands to generate docs for (empty = all)

-h, --help

Print help.