Pretty Output
pretty controls formatting. engine selects how we build the object tree:
legacy: parse Typer-generated markdown (deprecated)native: walk the Click command tree
Engine Matrix
| pretty | engine | behavior |
|---|---|---|
| false | legacy | emit Typer markdown as-is |
| true | legacy | legacy pretty output |
| false | native | native output with list items |
| true | native | native output with tables |
Example
mkdocs-typer2
A sample CLI
This is a multi-line help message.
Usage
mkdocs-typer2 [OPTIONS] COMMAND [ARGS]...
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--install-completion |
Install completion for the current shell. | No | - |
--show-completion |
Show completion for the current shell, to copy it or customize the installation. | No | - |
Commands
| Name | Description |
|---|---|
docs |
Generate docs for a project |
hello |
Some docstring content |
subapp |
Subcommands
docs
Generate docs for a project
Usage
mkdocs-typer2 docs [OPTIONS]
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--name |
The name of the project | Yes | - |
hello
Some docstring content
Usage
mkdocs-typer2 hello [OPTIONS] NAME
Arguments
| Name | Description | Required |
|---|---|---|
NAME |
The name of the person to greet | Yes |
Options
| Name | Description | Required | Default |
|---|---|---|---|
--caps / --no-caps |
Whether to capitalize the name | No | no-caps |
--color |
The color of the output | No | - |
subapp
No description available
Usage
mkdocs-typer2 subapp [OPTIONS] COMMAND [ARGS]...
Arguments
No arguments available
Options
No options available
Subcommands
sub-command
No description available
Usage
mkdocs-typer2 subapp sub-command [OPTIONS]
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--name |
The name of the person to greet | Yes | - |
sub-command-2
No description available
Usage
mkdocs-typer2 subapp sub-command-2 [OPTIONS]
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--name |
The name of the person to greet | Yes | - |