688c506a55
The canonical home for the golang.org website by now is the golang.org/x/website/cmd/golangorg command. That is the command that should be used to run the website locally instead of godoc. This change reduces the scope of x/tools/cmd/godoc to be a minimal Go Documentation Server. It removes the remaining pieces of the golang.org website and changes the title from "The Go Programming Language" to "Go Documentation Server". The web tree is modified as follows: • The index page has been modified to redirect to /pkg/, which serves a list of packages. • The /doc/ tree is removed. • The /robots.txt and /opensearch.xml pages are removed, since the primary use case for godoc now is a local web server. • The Google Analytics sections are removed from static templates, since it's always an empty value in local web server mode. Fixes golang/go#32011 Updates golang/go#29206 Change-Id: Id62c5f335fa2059774893ef4dcd268649278e99d Reviewed-on: https://go-review.googlesource.com/c/tools/+/207777 Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> Run-TryBot: Andrew Bonventre <andybons@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> 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/staticsostatic/static.gopicks up the change. -
Run
go install golang.org/x/tools/cmd/godocso the compiledgodocbinary picks up the change. -
Run
godoc -http=:6060and view your changes in the browser. You may need to disable your browser's cache to avoid reloading a stale file.