/godocgo

An example of good godoc documentation.

Primary LanguageGoMIT LicenseMIT

godocgo GoDoc

An in-depth guide to writing godoc, written in godoc.

To read the docs in your browser right now, click on the godoc reference above to see the documentation, which will bring you to https://godoc.org/github.com/natefinch/godocgo

Or you can run godoc locally:

  go get golang.org/x/tools/cmd/godoc
  go get github.com/natefinch/godocgo
  godoc -http=:8080

(you can skip the first step if you already have godoc installed)

Then open http://localhost:8080/pkg/github.com/natefinch/godocgo to read the docs locally.