commit | 117627b3c2b2bd5ae6ac92b9e8e3a82f51aa6a6d | [log] [tgz] |
---|---|---|
author | Russ Cox <rsc@golang.org> | Tue Jun 01 10:33:20 2021 -0400 |
committer | Russ Cox <rsc@golang.org> | Mon Jun 14 17:41:29 2021 +0000 |
tree | 7db522dcd6d64fcb392c1cb283dad1655bc89e0e | |
parent | 4c9e549253faa360e399b19be93adb3ad820ca4e [diff] |
internal/godoc: refactor into internal/web [generated] What's left of internal/godoc is mainly a simple web server for static content (plus the package docs provided by internal/pkgdoc) and bears little resemblance to the original godoc. Revamp the API and retire the name, moving to internal/web. CL generated by the script below. [git-generate] cd internal/godoc mv util.go istext.go mv godoc_test.go template_test.go mv server_test.go site_test.go rf ' mv TabWidth tabWidth mv IsText isText mv TabSpacer tabSpacer mv Presentation Site mv NewPresentation NewSite mv writerCapturesErr writeErrorSaver rm marshalJSON mv redirect maybeRedirect mv redirectFile maybeRedirectFile mv Site.serveText Site.serveRawText mv Site.serveTextFile Site.serveText mv Site.serveDirectory Site.serveDir mv Site.initFuncMap Site.initDocFuncs mv \ toFS \ Site \ NewSite \ Site.ServeError \ Site.ServeHTTP \ Site.ServePage \ Page \ Site.fullPage \ Page.Invoke \ writeErrorSaver \ writeErrorSaver.Write \ applyTemplateToResponseWriter \ Site.serveFile \ maybeRedirect \ maybeRedirectFile \ doctype \ Site.serveHTML \ Site.serveDir \ Site.serveText \ selRx \ rangeSelection \ Site.serveRawText \ Site.googleCN \ site.go mv example_nameFunc example_name mv example_suffixFunc example_suffix mv srcPosLinkFunc srcPosLink mv \ siteFuncs \ example_name \ example_suffix \ srcToPkg \ Page.SrcPkgLink \ Page.SrcBreadcrumb \ Page.SrcPosLink \ srcPosLink \ sitefuncs.go mv \ docServer \ docServer.ServeHTTP \ Page.ModeQuery \ pkgdoc.go mv metaJSON fileJSON mv extractMetadata parseFile mv \ file \ fileJSON \ join \ open \ jsonStart \ parseFile \ file.go mv \ Site.initDocFuncs \ Site.code \ Site.contents \ stringFor \ Site.oneLine \ Site.multipleLines \ parseArg \ match \ docfuncs.go mv Site.ServeError.p Site.ServeError.s mv Site.ServeHTTP.p Site.ServeHTTP.s mv Site.ServePage.p Site.ServePage.s mv Site.code.p Site.code.s mv Site.contents.p Site.contents.s mv Site.fullPage.p Site.fullPage.s mv Site.googleCN.p Site.googleCN.s mv Site.initDocFuncs.p Site.initDocFuncs.s mv Site.multipleLines.p Site.multipleLines.s mv Site.oneLine.p Site.oneLine.s mv Site.serveDir.p Site.serveDir.s mv Site.serveFile.p Site.serveFile.s mv Site.serveHTML.p Site.serveHTML.s mv Site.serveRawText.p Site.serveRawText.s mv Site.serveText.p Site.serveText.s mv Site.writeNode.p Site.writeNode.s mv Page.pres Page.site mv astfuncs.go docfuncs.go examplefuncs.go \ file.go istext.go markdown.go pkgdoc.go \ site.go site_test.go sitefuncs.go \ tab.go template_test.go \ golang.org/x/website/internal/web ' rm godoc.go meta.go page.go pres.go server.go template.go cd ../../cmd/golangorg rf ' mv pres site ' Change-Id: Ic03a2dbe14f74c60bd6a5a86ba4d3f36d8c5bea8 Reviewed-on: https://go-review.googlesource.com/c/website/+/317656 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
This repo holds content and serving programs for the golang.org web site.
Content is in _content/. Server code is in cmd/ and internal/.
To run the server to preview local content changes, use:
go run ./cmd/golangorg
The supporting programs cmd/admingolangorg and cmd/googlegolangorg are the servers for admin.golang.org and google.golang.org. (They do not use the _content/ directory.)
Each command directory has its own README.md explaining deployment.
This repository uses prettier to format JS and CSS files.
The version of prettier
used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the website repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/website:” in the subject line, so it is easy to find.