https://github.com/jonnrb/vanity
Utilities for running a golang vanity URL
https://github.com/jonnrb/vanity
docker go godoc golang vanity-url
Last synced: 5 months ago
JSON representation
Utilities for running a golang vanity URL
- Host: GitHub
- URL: https://github.com/jonnrb/vanity
- Owner: jonnrb
- License: other
- Created: 2018-06-07T17:08:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-02T03:39:09.000Z (about 6 years ago)
- Last Synced: 2025-08-14T00:36:14.297Z (11 months ago)
- Topics: docker, go, godoc, golang, vanity-url
- Language: Go
- Homepage:
- Size: 80.1 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vanity [](https://godoc.org/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 godoc.org (or somewhere else)
- Redirects Go tool to VCS
- Redirects godoc.org to browsable files
## Installation
```bash
go get go.jonnrb.io/vanity
```
## 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)
## Contributing
Shoot me an email with a repo and branch to pull (or even better, use
[git-request-pull](https://git-scm.com/docs/git-request-pull)).