File: README.md

package info (click to toggle)
golang-github-alecthomas-mango-kong 0.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 248 kB
  • sloc: sh: 32; makefile: 3
file content (18 lines) | stat: -rw-r--r-- 424 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
# Mango (man page generator) integration for Kong

This package allows [Kong](https://github.com/alecthomas/kong) packages
to generate man pages using [Mango](https://github.com/muesli/mango).

Simply add `mangokong.ManFlag` to your CLI struct:

```go
var cli struct {
	Man mangokong.ManFlag `help:"Write man page."`
}
```

## Example

This is what the [included example](./example) looks like:

![example.1](example.1.png)