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