tree: 130d53c2ec329cfaa631864150943c16829c8175 [search]
  1. md2man/
  2. .gitignore
  3. .golangci.yml
  4. Dockerfile
  5. go-md2man.1.md
  6. LICENSE.md
  7. Makefile
  8. md2man.go
  9. README.md
man/vendor/github.com/cpuguy83/go-md2man/v2/README.md

go-md2man

Converts markdown into roff (man pages).

Uses blackfriday to process markdown into man pages.

Usage

go install github.com/cpuguy83/go-md2man/v2@latest

go-md2man -in /path/to/markdownfile.md -out /manfile/output/path

For go 1.24 and above, you can run it with go tool:

go get -tool github.com/cpuguy83/go-md2man/v2@latest
# it will be appended to `tool` directive in go.mod file

go tool go-md2man -in /path/to/markdownfile.md -out /manfile/output/path