Go by Example
Content and build toolchain for Go by Example, a site that teaches Go via annotated example programs.
The Go by Example site is built by extracting code and
comments from source files in
examples and rendering
templates into a static
directory. The programs implementing this build process
tools, along with dependencies specified in
public directory can be served by any
static content system. The production site uses S3 and
CloudFront, for example.
To build the site you'll need Go installed. Run:
To build continuously in a loop:
To see the site locally:
http://127.0.0.1:8000/ in your browser.
To upload the site:
$ export AWS_ACCESS_KEY_ID=... $ export AWS_SECRET_ACCESS_KEY=... $ tools/upload
This work is copyright Mark McGranaghan and licensed under a Creative Commons Attribution 3.0 Unported License.
Contributor translations of the Go by Example site are available in:
- Chinese by gobyexample-cn
- French by keirua
- Italian by the Go Italian community
- Japanese by spinute
- Korean by mingrammer
- Russian by badkaktus
- Ukrainian by butuzov
- Brazilian Portuguese by lcslitx
- Vietnamese by s6k Gopher
I found a problem with the examples; what do I do?
We're very happy to fix problem reports and accept contributions! Please submit
an issue or send a Pull Request.
CONTRIBUTING.md for more details.
What version of Go is required to run these examples?
Given Go's strong backwards compatibility guarantees, we expect the vast majority of examples to work on the latest released version of Go as well as many older releases going back years.
That said, some examples show off new features added in recent releases; therefore, it's recommended to try running examples with the latest officially released Go version (see Go's release history for details).
I'm getting output in a different order from the example. Is the example wrong?
Some of the examples demonstrate concurrent code which has a non-deterministic execution order. It depends on how the Go runtime schedules its goroutines and may vary by operating system, CPU architecture, or even Go version.
Similarly, examples that iterate over maps may produce items in a different order from what you're getting on your machine. This is because the order of iteration over maps in Go is not specified and is not guaranteed to be the same from one iteration to the next.
It doesn't mean anything is wrong with the example. Typically the code in these examples will be insensitive to the actual order of the output; if the code is sensitive to the order - that's probably a bug - so feel free to report it.