qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 15:14:44 -07:00
Code Releases Activity
9ee5ef7a2c
go/godoc
History
Tamir Duberstein 5e2df02acb godoc/static: update jquery.treeview to 1.4.2 
This has the primary benefit of clarifying the license as MIT.

Images have been "losslessly compressed" upstream; see
https://github.com/jzaefferer/jquery-treeview/commit/ca711d9.

Retrieved from
https://github.com/jzaefferer/jquery-treeview/releases/tag/1.4.2.

Change-Id: Ia111cbdf246d9adafa3d1c8cfbd7f0c5763cc935
Reviewed-on: https://go-review.googlesource.com/c/tools/+/223077
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2020-03-12 15:35:18 +00:00
..
analysis
golangorgenv godoc/env: replace with golangorgenv 2019-03-07 16:39:06 +00:00
redirect all: fix some staticcheck errors 2020-01-29 04:53:41 +00:00
static godoc/static: update jquery.treeview to 1.4.2 2020-03-12 15:35:18 +00:00
util godoc/util: serve SVG files raw 2019-05-16 01:51:32 +00:00
vfs all: remove many cases of space-space 2019-12-30 19:07:42 +00:00
corpus.go godoc: remove Corpus.testDir field 2019-09-24 05:20:46 +00:00
dirtrees_test.go
dirtrees.go all: fix some staticcheck errors 2020-01-29 04:53:41 +00:00
format.go godoc: remove leading tabs while formatting text 2019-02-05 05:01:22 +00:00
godoc17_test.go
godoc_test.go
godoc.go all: fix some staticcheck errors 2020-01-29 04:53:41 +00:00
index_test.go
index.go
linkify.go
meta.go
page.go godoc/env: replace with golangorgenv 2019-03-07 16:39:06 +00:00
parser.go godoc: re-add test for ignoring //line comments in source code 2019-05-28 20:18:05 +00:00
pres.go cmd/godoc, godoc/static: remove remnants of golang.org website 2019-11-20 19:55:55 +00:00
README.md
search.go
server_test.go godoc: re-add test for ignoring //line comments in source code 2019-05-28 20:18:05 +00:00
server.go godoc, godoc/vfs: improve documentation of GetPageInfo, hasPathPrefix 2019-09-29 04:10:59 +00:00
snippet.go
spec_test.go
spec.go
spot.go
tab.go
template.go
versions_test.go
versions.go

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.