Skip to content

Latest commit

 

History

History
 
 

godoc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
analysis
analysis
 
 
redirect
redirect
 
 
static
static
 
 
util
util
 
 
vfs
vfs
 
 
README.md
README.md
 
 
corpus.go
corpus.go
 
 
dirtrees.go
dirtrees.go
 
 
dirtrees_test.go
dirtrees_test.go
 
 
format.go
format.go
 
 
godoc.go
godoc.go
 
 
godoc17_test.go
godoc17_test.go
 
 
godoc_test.go
godoc_test.go
 
 
index.go
index.go
 
 
index_test.go
index_test.go
 
 
linkify.go
linkify.go
 
 
markdown.go
markdown.go
 
 
meta.go
meta.go
 
 
page.go
page.go
 
 
parser.go
parser.go
 
 
pres.go
pres.go
 
 
search.go
search.go
 
 
server.go
server.go
 
 
server_test.go
server_test.go
 
 
snippet.go
snippet.go
 
 
spec.go
spec.go
 
 
spec_test.go
spec_test.go
 
 
spot.go
spot.go
 
 
tab.go
tab.go
 
 
template.go
template.go
 
 
versions.go
versions.go
 
 
versions_test.go
versions_test.go
 
 

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.