2a413a02cc
(Forked off Yury Smolsky's CL 176618) With this change, the playground.js client now asks the server to do a vet check in the same HTTP request as the /compile (and run) step. If the server replies that it understands the request (VetErrors or VetOK in the repsonse), then the client can avoid the latency of a second HTTP roundtrip. We'll remove the /vet handler after we see it fall out of use from older clients. Updates golang/go#31970 Change-Id: I5b123883e19cbc6a8ec30c50705e6b945a4d322d Reviewed-on: https://go-review.googlesource.com/c/tools/+/176939 Reviewed-by: Andrew Bonventre <andybons@golang.org> |
||
---|---|---|
.. | ||
analysis | ||
golangorgenv | ||
redirect | ||
static | ||
util | ||
vfs | ||
corpus.go | ||
dirtrees_test.go | ||
dirtrees.go | ||
format.go | ||
godoc17_test.go | ||
godoc_test.go | ||
godoc.go | ||
index_test.go | ||
index.go | ||
linkify.go | ||
meta.go | ||
page.go | ||
parser.go | ||
pres.go | ||
README.md | ||
search.go | ||
server_test.go | ||
server.go | ||
snippet.go | ||
spec_test.go | ||
spec.go | ||
spot.go | ||
tab.go | ||
template.go | ||
versions_test.go | ||
versions.go |
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/static
sostatic/static.go
picks up the change. -
Run
go install golang.org/x/tools/cmd/godoc
so the compiledgodoc
binary picks up the change. -
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.