https://github.com/leighmcculloch/vangen
Tool for generating static HTML for Go vanity import paths.
https://github.com/leighmcculloch/vangen
go golang
Last synced: about 2 months ago
JSON representation
Tool for generating static HTML for Go vanity import paths.
- Host: GitHub
- URL: https://github.com/leighmcculloch/vangen
- Owner: leighmcculloch
- License: mit
- Created: 2017-08-07T05:27:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T13:28:33.000Z (10 months ago)
- Last Synced: 2025-04-14T16:12:11.598Z (about 2 months ago)
- Topics: go, golang
- Language: Go
- Homepage: https://4d63.com/vangen
- Size: 60.5 KB
- Stars: 82
- Watchers: 3
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vangen
[](https://goreportcard.com/report/github.com/leighmcculloch/vangen)
[](https://pkg.go.dev/github.com/leighmcculloch/vangen)
Vangen is a tool for generating static HTML for Go vanity import paths.
Go vanity import paths work by serving a HTML file that tells the `go get` tool where to download the source from. You can still host the source code at Github, BitBucket, but the vanity URL gives you portability and other benefits.
## Why
* Maintain Go vanity import paths with a simple definition file `vangen.json`.
* Host Go vanity import paths using static hosting. No need for Google AppEngine, Heroku, etc. Host the files on Github Pages, AWS S3, Google Cloud Storage, etc.
## Install
### Source
```
go get 4d63.com/vangen
```
### Linux
```
curl -sSL https://github.com/leighmcculloch/vangen/releases/download/v1.1.3/vangen_1.1.3_linux_amd64.tar.gz | tar xz -C /usr/local/bin vangen
```
### Mac
```
curl -sSL https://github.com/leighmcculloch/vangen/releases/download/v1.1.3/vangen_1.1.3_darwin_amd64.tar.gz | tar xz -C /usr/local/bin vangen
```
### Windows
[Download the executable](https://github.com/leighmcculloch/vangen/releases/download/v1.1.3/vangen_1.1.3_windows_amd64.zip), and save it to your path.
## Usage
1. Create a `vangen.json` (see examples below)
2. Run `vangen`
3. Host the files outputted in `vangen/` at your domain
4. Try it out with `go get [domain]/[package]`
```
$ vangen -help
Vangen is a tool for generating static HTML for hosting Go repositories at a vanity import path.
Usage:
vangen [-config=vangen.json] [-out=vangen/]
Flags:
-config filename
vangen json configuration filename (default "vangen.json")
-help
print this help list
-out directory
output directory that static files will be written to (default "vangen/")
-verbose
print verbose output when run
-version
print program version
```
## Examples
### Minimal
The repository `type` and `source` properties will be set automatically when `url` begins with `https://github.com` or `https://gitlab.com`. Below is a minimal config for a project hosted on GitHub.
```json
{
"domain": "4d63.com",
"repositories": [
{
"prefix": "optional",
"subs": [
"template"
],
"url": "https://github.com/leighmcculloch/go-optional"
}
]
}
```
### All fields
```json
{
"domain": "4d63.com",
"docsDomain": "pkg.go.dev",
"repositories": [
{
"prefix": "optional",
"subs": [
"template"
],
"type": "git",
"hidden": false,
"url": "https://github.com/leighmcculloch/go-optional",
"source": {
"home": "https://github.com/leighmcculloch/go-optional",
"dir": "https://github.com/leighmcculloch/go-optional/tree/master{/dir}",
"file": "https://github.com/leighmcculloch/go-optional/blob/master{/dir}/{file}#L{line}"
},
"website": {
"url": "https://github.com/leighmcculoch/go-optional"
}
}
]
}
```