Golds is an experimental Go local docs server, a Go docs generator, and a Go code reader.
Demo: the generated docs for standard packages.
Code: on github. Any feedback, including PR and bug reports, are welcomed.
Please follow @Go100and1 to get the latest news of Golds (and all kinds of Go details/facts/tips/etc.).
golds . to show docs of the package in the current directory (and all its dependency packages).golds ./... to show docs of all the package under the current directory (and all their dependency packages).golds std to show docs of standard packages.
Each of the above commands will open a browser window automatically.
We can use the -s or -silent options to turn off the behavior.
golds -gen -dir=generated .golds -gen -dir=generated ./...golds -gen -dir=generated std
The -dir option is optional and its default value is . (the working directory).
Please read the project readme file to get more options.
The third usage of Golds is to serve files within a directory.
For example, we can run golds -dir=. (or simply golds)
from the HTML docs generation directory to view the generated docs in browser.
"Golds" is an abbreviation of Go local docs server.
I didn't find a Go tool showing type implementation relations, so I decided to write one. In doing this, I got many new ideas which form the tool to the final Golds design.
Yes. But if you do want to serve your package docs on Internet, it is best to serve the generated HTML static doc pages to lower the server cost.
If a Go project needs cgo, then a proper C/C++ compiler is needed.
Some projects might need large memory capacity to analyze. For example, the recommended memory capacity to analyze the Kubernetes project is 8G+. However, 500M to 2G memory is okay for most Go projects.
The Go 101 project is hosted on Github. Welcome to improve Go 101 articles by submitting corrections for all kinds of mistakes, such as typos, grammar errors, wording inaccuracies, description flaws, code bugs and broken links.
If you would like to learn some Go details and facts every serveral days, please follow Go 101's official Twitter account: @go100and1.