/gobyexample

Go by Example

Primary LanguageGo

Go by Example

Content, toolchain, and web server for Go by Example

The original source come from gobyexample.com.

Overview

The Go by Example site is built by extracting code & comments from source files in examples and rendering that data via the site templates. The programs implementing this build process are in tools.

The build process produces a directory of static files - public - suitable for serving by any modern HTTP server. We include a lightweight Go server in server.go.

Building

To build the site:

# install python-pygments package on your linux distribution.
$ go get github.com/russross/blackfriday  # markdown processor
$ rm public/*  # optional step for force re-generate
$ tools/build
$ open index.html or public/index.html

To build continuously in a loop:

$ tools/build-loop

Optional Tools

$ cd tools
$ make clean # remove all generated data
$ make local # cache css/js files in local disk for networkless environment
$ make css   # use yuicompresser to compress site.css
$ make       # build *.go binaray for reduce rebuild time in 1 second
	     # make also call 'make css' and generate pages

License

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:

Thanks

Thanks to Jeremy Ashkenas for Docco, which inspired this project.