https://github.com/cpuguy83/go-md2man
https://github.com/cpuguy83/go-md2man
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cpuguy83/go-md2man
- Owner: cpuguy83
- License: mit
- Created: 2014-07-30T20:03:48.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T23:58:25.000Z (about 1 month ago)
- Last Synced: 2025-04-22T04:29:34.737Z (12 days ago)
- Language: Go
- Size: 346 KB
- Stars: 249
- Watchers: 12
- Forks: 69
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- go-awesome - go-md2man - Convert markdown to manpage content (Open source library / Word Processing)
README
go-md2man
=========
Converts markdown into roff (man pages).
Uses [blackfriday](https://github.com/russross/blackfriday) to process markdown into man pages.
### Usage
```bash
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`:
```bash
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
```