[mirror] Home of the pkg.go.dev website

Перейти к файлу

Weida Hong 7d0ea0a0e8 internal/godoc/dochtml: enhance output parsing for example func Current logic for detecting "concluding line comment" is not strict enough that it may cause false-positive, causing some normal comment (and code following it) to be discarded in the rendered web page. Ensure that "concluding line comment" can only be prefixed by spaces. Also add corresponding test case. Fixes golang/go#65450 Change-Id: Ief9ec5326aa94965ca02d3278398cc5663ba395f GitHub-Last-Rev: `7312ff3dff` GitHub-Pull-Request: golang/pkgsite#93 Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/600415 kokoro-CI: kokoro <noreply+kokoro@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Robert Findley <rfindley@google.com> Reviewed-by: Alan Donovan <adonovan@google.com>		2024-09-13 13:08:37 +00:00
.github/workflows	…
cmd	all: fix printf(var) mistake detected by latest printf checker	2024-09-05 03:04:40 +00:00
deploy	various: upgrade to go 1.23 containers	2024-08-20 16:40:08 +00:00
devtools	…
doc	…
internal	internal/godoc/dochtml: enhance output parsing for example func	2024-09-13 13:08:37 +00:00
migrations	…
static	…
tests	Revert "static/frontend: made cancel button in search field keyboard accessible"	2024-08-24 13:55:52 +00:00
third_party	…
.dockerignore	…
.eslintignore	…
.eslintrc.yaml	pkgsite: remove the e2e tests	2022-01-31 19:10:20 +00:00
.gitignore	…
.prettierignore	…
.prettierrc.yaml	…
.stylelintignore	…
.stylelintrc.yaml	…
CONTRIBUTING.md	…
LICENSE	…
PATENTS	…
README.md	…
all.bash	…
go.mod	go.mod: update golang.org/x dependencies	2024-09-09 16:22:33 +00:00
go.sum	go.mod: update golang.org/x dependencies	2024-09-09 16:22:33 +00:00
jest.config.js	…
package-lock.json	…
package.json	ran `npm audit fix`	2024-05-16 15:30:42 +00:00
tsconfig.json	…

README.md

golang.org/x/pkgsite

This repository hosts the source code of the pkg.go.dev website, and pkgsite, a documentation server program.

pkg.go.dev: a site for discovering Go packages

Pkg.go.dev is a website for discovering and evaluating Go packages and modules.

You can check it out at https://pkg.go.dev.

pkgsite: a documentation server

pkgsite program extracts and generates documentation for Go projects.

Example usage:

$ go install golang.org/x/pkgsite/cmd/pkgsite@latest
$ cd myproject
$ pkgsite -open .

For more information, see the pkgsite documentation.

Requirements

Pkgsite requires Go 1.19 to run. The last commit that works with Go 1.18 is 9ffe8b928e. The last commit that works with Go 1.17 is 4d836c6a65.

Issues

If you want to report a bug or have a feature suggestion, please first check the known issues to see if your issue is already being discussed. If an issue does not already exist, feel free to file an issue.

For answers to frequently asked questions, see pkg.go.dev/about.

You can also chat with us on the #pkgsite Slack channel on the Gophers Slack.

Contributing

We would love your help!

Our canonical Git repository is located at go.googlesource.com/pkgsite. There is a mirror of the repository at github.com/golang/pkgsite.

To contribute, please read our contributing guide.

License

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.