| commit | 395738c0231112a7772e42f34ebec3006cb66f5c | [log] [tgz] |
|---|---|---|
| author | Matt T. Proud <matt.proud@gmail.com> | Thu May 15 22:00:58 2025 +0200 |
| committer | Jonathan Amsterdam <jba@google.com> | Fri Jul 04 08:46:40 2025 -0700 |
| tree | c16a21757a01c9b37ec81ddab3a78e5261cfe96a | |
| parent | ae590d8f0828128c9ff20b8ed794e7cf3ff86a7c [diff] |
static/doc: promote examples into TOC link tree. This change alters how the table of contents (TOC) is rendered to promote the listing of examples directly into the TOC itself as well as avoid nesting the examples under a sub-heading where they are likely not to be seen. A change like this assists beginners with providing immediate awareness that the concept of examples exists. Without this change, the whole idea of examples are easy to miss, as they are suggested essentially only in collapsible summary tags at the bottom of the respective identifier or scope they are attached to. Change-Id: Ic46d20180767c25092648355af52e935a6f45f4e Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/673435 Reviewed-by: Cherry Mui <cherryyz@google.com> kokoro-CI: kokoro <noreply+kokoro@google.com> Reviewed-by: Matt Proud <matt.proud@gmail.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Jonathan Amsterdam <jba@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.
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.
