commit | 691780b416aea390189b178fab383f45ba24e7ce | [log] [tgz] |
---|---|---|
author | Michael Matloob <matloob@golang.org> | Fri Dec 01 12:01:20 2023 -0500 |
committer | Michael Matloob <matloob@golang.org> | Wed Dec 06 20:55:46 2023 +0000 |
tree | d6c4c0441421ddbbe5f831e1fca84bbd6d2264b0 | |
parent | 47bf8d768e9d1689731bb05168b24d7b952efe56 [diff] |
internal/frontend: write version of ProcessReadme with rsc.io/markdown This change adds a version of ProcessReadme that uses rsc.io/markdown instead of goldmark. It includes most of the rewriting logic that the goldmark version of the code has except that the heading ids are rewritten slightly differently since we don't have access to the original markdown which the goldmark version uses. A future CL will probably change the processing the goldmark version does to produce heading ids to bring them in line. There are still many other diffs with the goldmark version of the code but most of them are a result of rsc.io/markdown not yet supporting GitHub-flavored markdown. For #61399 Change-Id: Ic8981bc241448268337dc3e98a537a71146a676d Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/547915 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Jonathan Amsterdam <jba@google.com> kokoro-CI: kokoro <noreply+kokoro@google.com>
This repository hosts the source code of the pkg.go.dev website, and pkgsite
, a documentation server program.
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
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.
Pkgsite requires Go 1.19 to run. The last commit that works with Go 1.18 is 9ffe8b928e4fbd3ff7dcf984254629a47f8b6e63. The last commit that works with Go 1.17 is 4d836c6a652cde92f433967680dfd6171a91ec12.
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.
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.