feat(docs): add UsageText to docs output for markdown and man page generation (#1171 )

* feat(docs): add UsageText to docs output for markdown and man page generation

* feat(docs): updated tests, DRYd up code, cleaned up string logic

* fix(lint): fixed go1.15 lint errors

2021-05-20 21:04:51 -04:00

1.0 KiB

Raw Blame History

% greet 8

NAME

greet - Some app

SYNOPSIS

greet

DESCRIPTION

app [first_arg] [second_arg]

Usage:

greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

COMMANDS

config, c

another usage test

--another-flag, -b: another usage text

--flag, --fl, -f="":

sub-config, s, ss

another usage test

--sub-command-flag, -s: some usage text

--sub-flag, --sub-fl, -s="":

info, i, in

retrieve generic information

some-command

usage, u

standard usage text

Usage for the usage text
- formatted:  Based on the specified ConfigMap and summon secrets.yml
- list:       Inspect the environment for a specific process running on a Pod
- for_effect: Compare 'namespace' environment with 'local'

```
func() { ... }
```

Should be a part of the same code block