Golds, an experimental Go local docs server, Go docs generation tool, and code reader. ^NEW!
-- show type implementation relations --
-- smooth code view experiences --
-- and more... --

Golds

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.

Usages

The main usage of Golds is to start a local docs server for a project, to either read package docs or study source code of the project. We can

run golds . to show docs of the package in the current directory (and all its dependency packages).
run golds ./... to show docs of all the package under the current directory (and all their dependency packages).
run golds std to show docs of standard pacakges.

Each of the above commands will open a browser window automatically. We can use the -s or -silent options to turn off the behavior.

The second usage of Golds is to generate static HTML doc pages for a project:

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.

FAQ

What does Golds mean?

"Golds" is an abbreviation of Go local docs server.

Why Golds?

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.

Is Golds recommended to run locally?

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.

What are the requirements to run Golds?

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.

The digital versions of this book are available at the following places:

Leanpub store, $19.99+, Leanpub gets 20%, Tapir gets 80%.
Apple Books store, $19.99, Apple gets 30%, Tapir gets 70%.
Amazon Kindle store, $39.99, Amazon gets 65%, Tapir gets 35%.
Free ebooks, including pdf, epub and azw3 formats.

Tapir, the author of Go 101, has spent 3+ years on writing the Go 101 book and maintaining the go101.org website. New contents will continue being added to the book and the website from time to time. Tapir is also an indie game developer. You can also support Go 101 by playing Tapir's games (made for both Android and iPhone/iPad):

Color Infection (★★★★★), a physics based original casual puzzle game. 140+ levels.
Rectangle Pushers (★★★★★), an original casual puzzle game. Two modes, 104+ levels.
Let's Play With Particles, a casual action original game. Three mini games are included.

Individual donations via PayPal and cryptocurrencies are welcome too:

Bitcoin: 1xucQbv5jujFPPwhyg395ri5yV71hx9g9
Ethereum: 0x5dc4aa2c2bbfaadae373dadcfca11b3358912212