gobyexample/README.md at f313b49cf24f23b04e0e69e06cf0b5476e7fbc4b

adamjgray f313b49cf2 Updated build instructions to use tools/ instead of tool/

The build instructions seem to have a typo.  The console commands listed use tool/ instead of tools/.

2012-10-11 14:27:30 -03:00

1.2 KiB

Raw Blame History

Go by Example

Content and toolchain for Go by Example.

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 suitable for serving by any modern HTTP server. The Go by Example site is served by a lightweight Go server.

Building

To build the site:

$ tools/build
$ open site/index.html

To build continuously in a loop:

$ tools/build-loop

Builds require the pygmentize binary for syntax highlighting.

Serving

The site is served by the gobyexample-server tool. To export to this tool:

$ SITEDIR = ../gobyexample-server/public tool/build

License

This work is licensed under a Creative Commons Attribution 3.0 Unported License.

Thanks

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

1.2 KiB Raw Blame History