| commit | 1592ba3fd9968564bab2fe9f61848dd3c321dad2 | [log] [tgz] |
|---|---|---|
| author | Jonathan Amsterdam <jba@google.com> | Wed Nov 25 16:19:23 2020 -0500 |
| committer | Jonathan Amsterdam <jba@google.com> | Thu Dec 03 13:06:22 2020 +0000 |
| tree | 1d419c94623c31414d9fd8a19e8e21e01c8279a3 | |
| parent | 557ca0dd3484eb88de44186e33f678486b1805c8 [diff] |
internal/frontend: extract links from readme markdown The Readme function now returns a list of links extracted from the readme file, for display elsewhere (such as the right sidenav). This CL extracts links from readmes written in markdown. A subsequent CL will do the same for HTML readmes. I could instead have rendered the markdown to HTML, then scanned the HTML for links, handling both cases. That would have been less code, but significantly slower in the common case of markdown, and since this code is on the serving path I didn't think that was good idea. Change-Id: I6a94c2e1919c79bb658ea3ec3428acf5a5ca23ce Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/273207 Trust: Jonathan Amsterdam <jba@google.com> Run-TryBot: Jonathan Amsterdam <jba@google.com> Reviewed-by: Julie Qiu <julie@golang.org>
Pkg.go.dev is a website for discovering and evaluating Go packages and modules.
You can check it out at https://pkg.go.dev.
Pkg.go.dev launched in November 2019, and is currently under active development by the Go team.
Here's what we are currently working on:
Design updates: We have some design changes planned for pkg.go.dev, to address UX feedback that we have received. You can expect a more cohesive search and navigation experience coming soon. We plan to share these designs for feedback once they are ready.
Godoc.org redirect: Longer term, we are working towards redirecting godoc.org traffic to pkg.go.dev. We know that there are features available on godoc.org that users want to see on pkg.go.dev, and we want to ensure that we address these. We’ve been keeping track of issues related to redirecting godoc.org traffic on Go issue #39144. These issues will be prioritized in the next few months. We also plan to continue improving our license detection algorithm.
Search improvements: We’ll be improving our search experience based on feedback in Go issue #37810, to make it easier for users to find the dependencies they are looking for and make better decisions around which ones to import.
We encourage everyone to begin using pkg.go.dev today for all of their needs and to file feedback! You can redirect all of your requests from godoc.org to pkg.go.dev, by clicking Always use pkg.go.dev at the top of any page on godoc.org.
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 go.dev/about.
You can also chat with us on the #tools slack channel on the Gophers slack.
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.
Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.