toyohime/README.md
yakumo.izuru 58ded33a69 Change godoc path to pkg.go.dev and add a manual page
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>

git-svn-id: file:///srv/svn/repo/toyohime/trunk@113 922d331f-388e-da47-97a9-ad700dc0b8b9
2024-02-09 21:22:42 +00:00

26 lines
898 B
Markdown

# Toyohime
Fork of [go.jonnrb.io/vanity](https://go.jonnrb.io/vanity)
A vanity import path is any import path that can be downloaded with
`go get` but isn't otherwise blessed by the `go` tool (e.g. GitHub,
BitBucket, etc.). A commonly used vanity import path is
"golang.org/x/...". This package attempts to mimic the behavior of
"golang.org/x/..." as closely as possible.
## Features
* Redirects browsers to godocs.io (or somewhere else)
* Redirects Go tool to VCS
* Redirects pkg.go.dev to browsable files
## Installation
```bash
go install marisa.chaotic.ninja/toyohime/cmd/toyohime@latest
```
## Specification
- [Remote Import Paths](https://golang.org/cmd/go/#hdr-Remote_import_paths)
- [GDDO Source Code Links](https://github.com/golang/gddo/wiki/Source-Code-Links)
- [Custom Import Path Checking](https://docs.google.com/document/d/1jVFkZTcYbNLaTxXD9OcGfn7vYv5hWtPx9--lTx1gPMs/edit)