tree: 648e987566d53eaf08ec1eb4e33eb628817afe4a [path history] [tgz]
  1. analysis/
  2. dl/
  3. proxy/
  4. redirect/
  5. short/
  6. static/
  7. util/
  8. vfs/
  9. appengine.go
  10. cmdline.go
  11. cmdline_test.go
  12. corpus.go
  13. dirtrees.go
  14. format.go
  15. godoc.go
  16. godoc17_test.go
  17. godoc_test.go
  18. index.go
  19. index_test.go
  20. linkify.go
  21. meta.go
  22. page.go
  23. parser.go
  24. pres.go
  26. search.go
  27. server.go
  28. snippet.go
  29. spec.go
  30. spot.go
  31. tab.go
  32. template.go


This directory contains most of the code for running a godoc server. The executable lives at

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/ -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 so static/static.go picks up the change.

  3. Run go install 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.