tree: 20e9c5ec40381dd8ffe0ef356e3ea4e406484d69 [path history] [tgz]
  1. README.md
  2. analysis/
  3. corpus.go
  4. dirtrees.go
  5. dirtrees_test.go
  6. format.go
  7. godoc.go
  8. godoc17_test.go
  9. godoc_test.go
  10. golangorgenv/
  11. index.go
  12. index_test.go
  13. linkify.go
  14. meta.go
  15. page.go
  16. parser.go
  17. pres.go
  18. redirect/
  19. search.go
  20. server.go
  21. server_test.go
  22. snippet.go
  23. spec.go
  24. spec_test.go
  25. spot.go
  26. static/
  27. tab.go
  28. template.go
  29. util/
  30. versions.go
  31. versions_test.go
  32. vfs/
godoc/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.