Pretty (Legacy Engine)
Legacy pretty mode parses Typer markdown and renders options/args as tables.
This path is deprecated in favor of the native engine.
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 | - |
--help |
Show this message and exit. | No | - |
Commands
| Name | Description |
|---|---|
docs |
Generate docs for a project |
hello |
Some docstring content |
subapp |
Subcommands
mkdocs-typer2 docs
Generate docs for a project
Usage
mkdocs-typer2 docs [OPTIONS]
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--name TEXT |
The name of the project | Yes | - |
--help |
Show this message and exit. | No | - |
mkdocs-typer2 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 [default: no-caps] | No | no-caps |
--color TEXT |
The color of the output | No | - |
--help |
Show this message and exit. | No | - |
mkdocs-typer2 subapp
No description available
Usage
mkdocs-typer2 subapp [OPTIONS] COMMAND [ARGS]...
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
Subcommands
mkdocs-typer2 subapp sub-command
No description available
Usage
mkdocs-typer2 subapp sub-command [OPTIONS]
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--name TEXT |
The name of the person to greet | Yes | - |
--help |
Show this message and exit. | No | - |
mkdocs-typer2 subapp sub-command-2
No description available
Usage
mkdocs-typer2 subapp sub-command-2 [OPTIONS]
Arguments
No arguments available
Options
| Name | Description | Required | Default |
|---|---|---|---|
--name TEXT |
The name of the person to greet | Yes | - |
--help |
Show this message and exit. | No | - |