qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 16:24:42 -07:00
Code Releases Activity
0d047c8d5a
go/godoc
History
Chris Broadfoot 5d76f8ce4f static: detect platform to hide/show unix/windows instructions 
Currently both "testUnix" and "testWindows" elements are shown simultaneously.
This change detects the correct platform to hide/show the appropriate
elements based on the viewer's browser.

Change-Id: I3afee7507d61b2d756127166caede85adcd531b8
Reviewed-on: https://go-review.googlesource.com/35103
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-01-10 22:41:44 +00:00
..
analysis go/ssa: support custom TestMain functions in test packages 2016-10-19 17:50:59 +00:00
dl godoc/dl: change "All versions" to "Archived versions" 2017-01-06 18:41:26 +00:00
proxy godoc/proxy: use HTTPS when bouncing through to the playground 2016-05-19 07:11:34 +00:00
redirect godoc: don't drop the query params when redirecting 2015-10-06 03:11:16 +00:00
short godoc: hide appengine dependencies behind build tags 2016-01-04 23:08:03 +00:00
static static: detect platform to hide/show unix/windows instructions 2017-01-10 22:41:44 +00:00
util tools: add import comments. 2014-12-09 22:42:16 +00:00
vfs godoc: remove some unused code 2017-01-09 19:59:23 +00:00
appengine.go godoc: hide and block share functionality from specific countries 2015-09-02 05:52:45 +00:00
cmdline_test.go godoc: add missing copyright 2015-04-27 04:29:37 +00:00
cmdline.go godoc: add missing copyright 2015-04-27 04:29:37 +00:00
corpus.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
dirtrees.go godoc: remove some unused code 2017-01-09 19:59:23 +00:00
format.go go.tools/godoc: Fix jump-to-line in source view. 2013-08-01 11:52:25 +10:00
godoc_test.go godoc: update struct field anchor code 2016-12-01 02:33:17 +00:00
godoc.go godoc: update struct field anchor code 2016-12-01 02:33:17 +00:00
index_test.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
index.go godoc: remove some unused code 2017-01-09 19:59:23 +00:00
linkify.go godoc: revert support for Go 1.8 aliases 2016-11-04 21:17:32 +00:00
meta.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
page.go godoc: drop outdated comment 2016-10-04 17:46:36 +00:00
parser.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11:00
pres.go cmd/godoc: accept GOOS and GOARCH URL parameters in -http mode 2016-02-04 22:11:53 +00:00
README.md godoc: add README 2017-01-09 19:14:34 +00:00
search.go godoc: don't quote search term to avoid escaping regexps 2016-02-05 01:57:33 +00:00
server.go godoc: don't select line numbers in orange 2017-01-09 17:48:59 +00:00
snippet.go godoc: revert support for Go 1.8 aliases 2016-11-04 21:17:32 +00:00
spec.go godoc: move bulk of the code to the package 2013-07-17 17:09:54 +10:00
spot.go godoc: add search results that point to documentation instead of source. 2013-11-21 11:55:42 -05:00
tab.go godoc: add missing copyright 2015-04-27 04:29:37 +00:00
template.go go.tools: use golang.org/x/... import paths 2014-11-10 08:50:40 +11: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.