Go by Example
Content and build toolchain for Go by Example, a site that teaches Go via annotated example programs.
Overview
The Go by Example site is built by extracting code and
comments from source files in examples and rendering
them via the templates into a static public
directory. The programs implementing this build process
are in tools, along with some vendor'd dependencies
in vendor.
The built public directory can be served by any
static content system. The production site uses S3 and
CloudFront, for example.
Building
To build the site you'll need Go and Python installed. Run:
$ go get github.com/russross/blackfriday
$ tools/build
$ open public/index.htmlTo build continuously in a loop:
$ tools/build-loopLicense
This work is copyright Mark McGranaghan and licensed under a Creative Commons Attribution 3.0 Unported License.
The Go Gopher is copyright Renée French and licensed under a Creative Commons Attribution 3.0 Unported License.
Translations
Contributor translations of the Go by Example site are available in:
- Chinese by everyx
- French by keirua
- Italian by the Go Italian community
- Spanish by the Go Mexico community
Thanks
Thanks to Jeremy Ashkenas for Docco, which inspired this project.