9bdeaddf5f
The cascading sylesheet from the users UI can be inverted. If the background color is altered in the textarea and the text style is left unchanged the text may become illegible. The default value of the textarea color is that of the users UI styling and is not the same as that of the document body. Setting color: inherit; resolves this. Fixes golang/go#29482 Change-Id: Iaa6780154e0bd01d2a8219d813468dab25331b46 GitHub-Last-Rev: 8706d7aa4e183f98144b0b958f745bab12b6ce75 GitHub-Pull-Request: golang/tools#70 Reviewed-on: https://go-review.googlesource.com/c/158137 Reviewed-by: Andrew Bonventre <andybons@golang.org> |
||
---|---|---|
.. | ||
analysis | ||
dl | ||
env | ||
proxy | ||
redirect | ||
short | ||
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.