mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
go/godoc
History
cui fliter dc88e7b4a2 godoc: fix some comments 
Change-Id: Ia43fc5183e97d7d612216722e5255734d28ac508
GitHub-Last-Rev: aa1b6bbb3740a32c8d141d122e880498ed46adba
GitHub-Pull-Request: golang/tools#403
Reviewed-on: https://go-review.googlesource.com/c/tools/+/436455
Reviewed-by: Ian Lance Taylor <iant@google.com>
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
 		2022-10-04 18:24:48 +00:00
..
analysis all: gofmt 2022-04-12 17:53:17 +00:00
redirect godoc/redirect: delete golang.org-specific code 2022-08-16 14:47:05 +00:00
static godoc: support go1.19 doc comment syntax 2022-07-19 22:18:38 +00:00
util all: gofmt 2022-04-12 17:53:17 +00:00
vfs all: gofmt 2022-04-12 17:53:17 +00:00
README.md godoc: add GoogleCN property to pages 2017-08-02 21:09:52 +00:00
corpus.go godoc: remove Corpus.testDir field 2019-09-24 05:20:46 +00:00
dirtrees.go all: gofmt 2022-04-12 17:53:17 +00:00
dirtrees_test.go godoc: add benchmark for directory scan 2018-04-15 15:36:21 +00:00
format.go all: gofmt 2022-04-12 17:53:17 +00:00
godoc.go godoc: fix some comments 2022-10-04 18:24:48 +00:00
godoc17_test.go all: go fmt ./... 2021-02-20 03:28:52 +00:00
godoc_test.go godoc: handle type parameters correctly in LinkifyText 2022-02-14 18:01:21 +00:00
index.go all: use constant to avoid repeated definitions 2022-09-19 15:32:23 +00:00
index_test.go x/tools/godoc: gofmt -s -w 2017-02-15 21:42:32 +00:00
linkify.go all: gofmt 2022-04-12 17:53:17 +00:00
markdown.go godoc: convert Markdown files to HTML during serving 2021-02-12 16:44:11 +00:00
meta.go all: gofmt 2022-04-12 17:53:17 +00:00
page.go godoc: delete GoogleCN logic 2021-03-12 18:55:53 +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
search.go godoc: delete GoogleCN logic 2021-03-12 18:55:53 +00:00
server.go all: gofmt 2022-04-12 17:53:17 +00:00
server_test.go godoc: fix addNames for generics 2022-01-06 16:18:51 +00:00
snippet.go godoc: add version info for struct fields 2018-07-17 23:22:00 +00:00
spec.go godoc: accept scanner.RawString too during EBNF parsing 2018-06-25 04:25:21 +00:00
spec_test.go godoc: accept scanner.RawString too during EBNF parsing 2018-06-25 04:25:21 +00:00
spot.go all: gofmt 2022-04-12 17:53:17 +00:00
tab.go godoc: add missing copyright 2015-04-27 04:29:37 +00:00
template.go godoc: fix test failure 2018-06-13 15:25:43 +00:00
tohtml_go119.go godoc: support go1.19 doc comment syntax 2022-07-19 22:18:38 +00:00
tohtml_other.go godoc: support go1.19 doc comment syntax 2022-07-19 22:18:38 +00:00
versions.go godoc: show earliest version when identifier was added 2021-02-09 00:10:52 +00:00
versions_test.go godoc: show earliest version when identifier was added 2021-02-09 00:10:52 +00:00

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.