dumbdown

Documentation
Login

Command dumbdown provides a simple conversion from go doc to markdown.

The transformation is not particularly smart. Some text is omitted; while other text is prepended with ## to make a markdown header.

Usage

go doc | dumbdown > README.md

One may also add "go:generate" comments:

//go:generate sh -c "go doc | dumbdown > README.md"

then use:

go generate ./...

to build a README.md for the module and each sub-package.