For example, this package import path is
go.mlcdf.fr/vanity-imports (instead of
- 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.
- From GitHub releases: download the binary corresponding to your OS and architecture.
- From source (make sure
$GOPATH/binis in your
go get go.mlcdf.fr/vanity-imports
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.
Generate the HTML pages
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.
Format for the
domain = "go.mlcdf.fr" # required output = "output" # default to dist repo_template = """<golang template>""" # override the default template for the repo page index_template = """<golang 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"
Generate the pages
go run .
Regenerate the pages on file changes and start a web server on http://localhost:3000.
Run the tests
go test ./...
There is no documentation for this package.