yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more readme

Browse Source
This commit is contained in:
Mark McGranaghan 2012-10-09 10:36:15 -07:00
parent 4468301eaf
commit c38a8df39d
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,12 +1,25 @@
## Go by Example ## Go by Example
Source for [Go by Example](https://gobyexample.com), a hands-on guide to Go. Source for [Go by Example](https://gobyexample.com), a
hands-on guide to Go.
### Generation ### Overview
The web site is generated from `.go` and `.md` source This repo contains:
files using a custom site generator.
* `src`: Go and Bash source code for the site
* `meta`: metadata used to generate the site
* `templates`: HTML templates and CSS for the site
* `tool`: toolchain used to generate the site
The site is built by by extracting the code & comments
from the .go and .sh source files in `src`, and rendering
that data according to `meta` and `templates` via the
programs in `tool`.
### Usage
Generation requires the [`pygmentize`](http://pygments.org/) Generation requires the [`pygmentize`](http://pygments.org/)
binary for syntax highlighting. binary for syntax highlighting.