Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlcdf/vanity-imports
Use a custom domain in your Go import path
https://github.com/mlcdf/vanity-imports
go golang static-site-generator
Last synced: about 1 month ago
JSON representation
Use a custom domain in your Go import path
- Host: GitHub
- URL: https://github.com/mlcdf/vanity-imports
- Owner: mlcdf
- License: mit
- Created: 2021-05-08T23:47:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T08:59:31.000Z (about 1 year ago)
- Last Synced: 2024-06-21T12:14:59.205Z (5 months ago)
- Topics: go, golang, static-site-generator
- Language: Go
- Homepage:
- Size: 43 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vanity-imports
[](https://github.com/mlcdf/vanity-imports/actions/workflows/test.yml)
Generate HTML pages that allow you to set ["custom" or "vanity" import paths](https://golang.org/doc/go1.4#canonicalimports) for your Go packages using the `go-import` meta tag ([read the specs](https://golang.org/cmd/go/#hdr-Remote_import_paths)).
For example, this package import path is `go.mlcdf.fr/vanity-imports` (instead of `github.com/mlcdf/vanity-imports`).
## Highlights
- Painless to host: it's only static files
- Designed to be used in a CI environment: ship as single binary with no OS dependencies
- Easy to configure and extend via a single TOML configuration file
- Use your own template for the index and the repo pages.
## Install
- From [GitHub releases](https://github.com/mlcdf/vanity-imports/releases): download the binary corresponding to your OS and architecture.
- From source (make sure `$GOPATH/bin` is in your `$PATH`):
```sh
go get go.mlcdf.fr/vanity-imports
```
## Usage
```
Usage:
vanity-imports [option]
Options:
--init creates a sample .vanity-imports.toml config file
-c, --config CONFIG path to the config. Defaults to .vanity-imports.toml
-V, --version print version
```
First, create a [config file](#configuration-format).
```sh
vanity-imports --init
```
Generate the HTML pages
```sh
vanity-imports
```
Upload the content of the `dist` directory to your web server or your favorite static hosting service such as GitHub Pages, OVHcloud Web Hosting or Netlify.
## Configuration format
Format for the `.vanity-imports.toml` file.
```toml
domain = "go.mlcdf.fr" # required
output = "output" # default to dist
repo_template = """""" # override the default template for the repo page
index_template = """""" # override the default template for the index page
[index]
description = ""
extra_head = "" # extra html tags appended to the head
title = "" # required
[repos]
[repos."/dyndns"] # domain + "/dyndns will be your package import path
repo = "https://github.com/mlcdf/dyndns/" # required. Url to the source repository
vcs = "git"
```
## Example usage
Check out the [netlify](https://github.com/mlcdf/vanity-imports/tree/netlify) branch to find the code behind https://go.mlcdf.fr/.
## Development
Generate the pages
```bash
go run .
```
Regenerate the pages on file changes and start a web server
on http://localhost:3000.
```bash
./scripts/dev.sh
```
Run the tests
```sh
go test ./...
```
## License
[MIT](https://choosealicense.com/licenses/mit/)