github.com/sectioneight/md-to-godoc

Markdown to Godoc converter

Sort of like godocdown, but in reverse.

md-to-godoc takes markdown as input, and generates godoc-formatted package documentation.

Status

Way, way alpha. Barebones. The minimalest.

Code example

Mostly here so we can see some code in godoc:

Sample list

• This is a test
• And another test

func main() {
  fmt.Println("Hello, world")
}

Usage

First, install the binary:

go get -u github.com/sectioneight/md-to-godoc

Then, run it on one or more packages. If you'd like to generate a doc.go file in the current package (that already has a README.md), simply run md-to-godoc with no flags:

md-to-godoc

Advanced usage

To generate doc.go for all subpackages, you can do something like the following:

find . -name README.md \
       -not -path "./vendor/*" | \
       xargs -I% md-to-godoc -input=%

Projects using md-to-godoc

• UberFx, on GitHub and godoc.org
• Jaeger, on Github and godoc.org

Licence

Apache 2.0