go
/
pkgsite
зеркало из https://github.com/golang/pkgsite.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
[mirror] Home of the pkg.go.dev website
4 764 коммитов 1 ветка 0 Теги 393 MiB
Go 83.9%
PLpgSQL 6.4%
TypeScript 4.4%
CSS 3.9%
Shell 1.4%
Перейти к файлу
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 .github/workflows: add govulncheck-action 2023-05-31 15:21:19 +00:00
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 Revert "static/frontend: made cancel button in search field keyboard accessible" 2024-08-24 13:55:52 +00:00
doc all: remove repeated definite articles 2023-04-27 19:44:20 +00:00
internal internal/godoc/dochtml: enhance output parsing for example func 2024-09-13 13:08:37 +00:00
migrations migrations: set search_documents.ln_imported_by_count NOT NULL 2021-10-25 17:48:39 +00:00
static Revert "static/frontend: made cancel button in search field keyboard accessible" 2024-08-24 13:55:52 +00:00
tests Revert "static/frontend: made cancel button in search field keyboard accessible" 2024-08-24 13:55:52 +00:00
third_party third_party/wait-for-it: replace with a simple go program 2023-12-24 13:03:50 +00:00
.dockerignore pkgsite: remove the e2e tests 2022-01-31 19:10:20 +00:00
.eslintignore root: ignore static build files in static 2021-06-12 14:34:29 +00:00
.eslintrc.yaml pkgsite: remove the e2e tests 2022-01-31 19:10:20 +00:00
.gitignore deploy: add config for unattended deploy trigger 2021-11-09 17:02:06 +00:00
.prettierignore root: ignore static build files in static 2021-06-12 14:34:29 +00:00
.prettierrc.yaml all: add initial side navigation UI experiment 2020-06-02 16:31:09 +00:00
.stylelintignore .stylelintignore: ignore minified CSS files 2021-08-23 19:10:05 +00:00
.stylelintrc.yaml pkgsite: upgrade stylelint npm packages 2022-01-18 16:22:23 +00:00
CONTRIBUTING.md doc,CONTRIBUTING.md: update go version to 1.19 2022-07-19 17:36:06 +00:00
LICENSE LICENSE: update per Google Legal 2024-07-16 16:11:11 +00:00
PATENTS discovery: initial boilerplate 2019-01-28 17:05:04 -05:00
README.md internal/godoc/dochtml: add type parameters on func synopsis 2023-11-08 11:23:22 +00:00
all.bash all: get all.bash to work 2024-08-24 13:58:12 +00:00
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 pkgsite: remove the e2e tests 2022-01-31 19:10:20 +00:00
package-lock.json all: get all.bash to work 2024-08-24 13:58:12 +00:00
package.json ran `npm audit fix` 2024-05-16 15:30:42 +00:00
tsconfig.json internal,static: update esbuild config 2021-08-24 15:52:50 +00:00

README.md

golang.org/x/pkgsite

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

Go Reference

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.

Links