Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/natefinch/godocgo
An example of good godoc documentation.
https://github.com/natefinch/godocgo
Last synced: 12 days ago
JSON representation
An example of good godoc documentation.
- Host: GitHub
- URL: https://github.com/natefinch/godocgo
- Owner: natefinch
- License: mit
- Created: 2014-03-28T12:13:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-09T03:09:33.000Z (almost 9 years ago)
- Last Synced: 2024-10-12T06:44:01.376Z (27 days ago)
- Language: Go
- Size: 24.4 KB
- Stars: 160
- Watchers: 9
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
godocgo [![GoDoc](https://godoc.org/github.com/natefinch/godocgo?status.png)](https://godoc.org/github.com/natefinch/godocgo)
=======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](http://localhost:8080/pkg/github.com/natefinch/godocgo) to read the docs locally.