mbk-lab
/
wide
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
wide/vendor/golang.org/x/tools/godoc
History
Liang Ding e39b302bdc ➕ Update vendor 2018-03-13 13:24:04 +08:00
..
analysis ➕ Update vendor 2018-03-13 13:24:04 +08:00
dl ➕ Update vendor 2018-03-13 13:24:04 +08:00
proxy ➕ Update vendor 2018-03-13 13:24:04 +08:00
redirect ➕ Update vendor 2018-03-13 13:24:04 +08:00
short ➕ Update vendor 2018-03-13 13:24:04 +08:00
static ➕ Update vendor 2018-03-13 13:24:04 +08:00
util ➕ Update vendor 2018-03-13 13:24:04 +08:00
vfs ➕ Update vendor 2018-03-13 13:24:04 +08:00
README.md ➕ Update vendor 2018-03-13 13:24:04 +08:00
appengine.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
cmdline.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
cmdline_test.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
corpus.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
dirtrees.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
format.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
godoc.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
godoc17_test.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
godoc_test.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
index.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
index_test.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
linkify.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
meta.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
page.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
parser.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
pres.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
search.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
server.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
snippet.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
spec.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
spot.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
tab.go ➕ Update vendor 2018-03-13 13:24:04 +08:00
template.go ➕ Update vendor 2018-03-13 13:24:04 +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.