poanetwork
/
istanbul-tools
mirror of https://github.com/poanetwork/istanbul-tools.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
istanbul-tools/vendor/golang.org/x/tools/godoc
History
Alan Chen f00e1c3053 glide, vendor: add log15 2017-09-12 12:16:48 +08:00
..
analysis glide, vendor: add log15 2017-09-12 12:16:48 +08:00
dl glide, vendor: add log15 2017-09-12 12:16:48 +08:00
proxy glide, vendor: add log15 2017-09-12 12:16:48 +08:00
redirect glide, vendor: add log15 2017-09-12 12:16:48 +08:00
short glide, vendor: add log15 2017-09-12 12:16:48 +08:00
static glide, vendor: add log15 2017-09-12 12:16:48 +08:00
util glide, vendor: add log15 2017-09-12 12:16:48 +08:00
vfs glide, vendor: add log15 2017-09-12 12:16:48 +08:00
README.md glide, vendor: add log15 2017-09-12 12:16:48 +08:00
appengine.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
cmdline.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
cmdline_test.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
corpus.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
dirtrees.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
format.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
godoc.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
godoc17_test.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
godoc_test.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
index.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
index_test.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
linkify.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
meta.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
page.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
parser.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
pres.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
search.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
server.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
snippet.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
spec.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
spot.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
tab.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00
template.go glide, vendor: add log15 2017-09-12 12:16:48 +08:00

README.md

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:

  1. Make changes to e.g. static/style.css.

  2. Run go generate golang.org/x/tools/godoc/static so static/static.go picks up the change.

  3. Run go install golang.org/x/tools/cmd/godoc so the compiled godoc binary picks up the change.

  4. Run godoc -http=:6060 and view your changes in the browser. You may need to disable your browser's cache to avoid reloading a stale file.