Skip to content
forked from natefinch/godocgo

An example of good godoc documentation.

License

Notifications You must be signed in to change notification settings

urandom2/godocgo

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

An example of good godoc documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 100.0%