https://github.com/tailscale/pkgsitelib
A fork of golang.org/x/pkgsite that can be used as a library in other projects.
https://github.com/tailscale/pkgsitelib
Last synced: about 1 year ago
JSON representation
A fork of golang.org/x/pkgsite that can be used as a library in other projects.
- Host: GitHub
- URL: https://github.com/tailscale/pkgsitelib
- Owner: tailscale
- License: bsd-3-clause
- Created: 2024-06-17T17:15:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T23:52:53.000Z (almost 2 years ago)
- Last Synced: 2024-06-25T00:47:29.317Z (almost 2 years ago)
- Language: Go
- Homepage:
- Size: 347 MB
- Stars: 2
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# pkgsitelib
pkgsitelib is a fork of [golang.org/x/pkgsite] that is intended to be used as a library for other projects.
pkgsite is built very explicitly to host the [pkg.go.dev] website, and as such,
it doesn't make it super easy to [run locally] (though that is gradually improving).
It is also not easy to customize or pull into another project as a library.
For example, almost the entire codebase is within an "internal" package,
which makes it impossible to import into another project.
pkgsitelib only does a few things, most notably of which is to eliminate the top "internal" package.
There are still several "internal" subpackages, but those have been left alone for now.
It also includes a couple of minor changes to make it easier to use or customize.
Ideally, this project will become obsolete and go away as pkgsite becomes more modular.
This is used internally at Tailscale to host documentation for our private Go packages.
[golang.org/x/pkgsite]: (https://pkg.go.dev/golang.org/x/pkgsite)
[pkg.go.dev]: (https://pkg.go.dev)
[run locally]: https://github.com/golang/go/issues/40371