.config/coc/extensions/coc-go-data/tools/pkg/mod/golang.org/x/tools@v0.0.0-20201028153306-37f0764111ff/godoc/README.md

   1 # godoc
   2
   3 This directory contains most of the code for running a godoc server. The
   4 executable lives at golang.org/x/tools/cmd/godoc.
   5
   6 ## Development mode
   7
   8 In production, CSS/JS/template assets need to be compiled into the godoc
   9 binary. It can be tedious to recompile assets every time, but you can pass a
  10 flag to load CSS/JS/templates from disk every time a page loads:
  11
  12 ```
  13 godoc -templates=$GOPATH/src/golang.org/x/tools/godoc/static -http=:6060
  14 ```
  15
  16 ## Recompiling static assets
  17
  18 The files that live at `static/style.css`, `static/jquery.js` and so on are not
  19 present in the final binary. They are placed into `static/static.go` by running
  20 `go generate`. So to compile a change and test it in your browser:
  21
  22 1) Make changes to e.g. `static/style.css`.
  23
  24 2) Run `go generate golang.org/x/tools/godoc/static` so `static/static.go` picks
  25 up the change.
  26
  27 3) Run `go install golang.org/x/tools/cmd/godoc` so the compiled `godoc` binary
  28 picks up the change.
  29
  30 4) Run `godoc -http=:6060` and view your changes in the browser. You may need
  31 to disable your browser's cache to avoid reloading a stale file.