d1a3278ee7
When a godoc Presentation is serving a file, it will sniff its contents to determine if it contains "human-readable" text. If it does, then it serves the contents of the file with surrounding HTML. SVG files should not be served with any additional HTML even though their contents are not a binary format (just like CSS or JS files). Updates golang/go#9936 Change-Id: Id3dd3b6cda4f103b08f6e924923426a86bd46ec8 Reviewed-on: https://go-review.googlesource.com/c/tools/+/177498 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
godoc
This directory contains most of the code for running a godoc server. The executable lives at golang.org/x/tools/cmd/godoc.
Development mode
In production, CSS/JS/template assets need to be compiled into the godoc binary. It can be tedious to recompile assets every time, but you can pass a flag to load CSS/JS/templates from disk every time a page loads:
godoc -templates=$GOPATH/src/golang.org/x/tools/godoc/static -http=:6060
Recompiling static assets
The files that live at static/style.css, static/jquery.js and so on are not
present in the final binary. They are placed into static/static.go by running
go generate. So to compile a change and test it in your browser:
-
Make changes to e.g.
static/style.css. -
Run
go generate golang.org/x/tools/godoc/staticsostatic/static.gopicks up the change. -
Run
go install golang.org/x/tools/cmd/godocso the compiledgodocbinary picks up the change. -
Run
godoc -http=:6060and view your changes in the browser. You may need to disable your browser's cache to avoid reloading a stale file.