commit | 3768cf1c566e355d2972f437ffb10001039f87b2 | [log] [tgz] |
---|---|---|
author | Russ Cox <rsc@golang.org> | Thu Jul 14 15:45:54 2022 -0400 |
committer | Russ Cox <rsc@golang.org> | Mon Jul 25 20:38:04 2022 +0000 |
tree | fda2dcb3fb4caf3da918f8eebcbb25b72ac23a9e | |
parent | d84a70a112fb5f41db3a544b09dce32bd17f6278 [diff] |
internal/pkgdoc: use new doc comment formatter directly The backport update brought in the new doc comment formatter, and it is already used via the deprecated APIs, but using the direct APIs allows better resolution of doc links within a given package. Fixes golang/go#51082. Change-Id: I6e8ff47b0381526a56d104c22c4ad69f716d4960 Reviewed-on: https://go-review.googlesource.com/c/website/+/417651 Reviewed-by: Jonathan Amsterdam <jba@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Russ Cox <rsc@golang.org>
This repo holds content and serving programs for the go.dev and golang.org web sites.
Content is in _content/ (go.dev) and tour/ (go.dev/tour). Server code is in cmd/ and internal/.
To run the combined go.dev+golang.org 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/ directories.)
Each command directory has its own README.md explaining deployment.
This repository uses eslint to format JS and TS files, and stylelint to format CSS files.
See also:
It is encouraged that all JS, TS, and CSS code be run through formatters before submitting a change. However, it is not a strict requirement enforced by CI.
./npm install
./npx eslint [options] [file] [dir]
./npx stylelint [input] [options]
TypeScript files served from _content are transformed into JavaScript. Reference .ts files in html templates as module code.
<script type="module" src="/ts/filename.ts">
Write unit tests for TypeScript code using the jest testing framework.
./npx jest [TestPathPattern]
Each time a CL is reviewed and submitted, the code is deployed to App Engine. See cmd/golangorg/README.md for details.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://go.dev/doc/contribute.
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.