vanity-imports

command module
Version: v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2021 License: MIT Imports: 10 Imported by: 0

README

vanity-imports

test

Generate HTML pages that allows you to set "custom" or "vanity" import paths for your Go packages using the go-import meta tag (read the specs).

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

Install

  • From GitHub releases: download the binary corresponding to your OS and architecture.
  • From source (make sure $GOPATH/bin is in your $PATH):
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.

vanity-imports --init

Generate the HTML pages

vanity-imports

Upload the content of the dist directory to your web server or your favorite static hosting service such as GitHub Pages, Netlify or Vercel.

Configuration format

Format for the .vanity-imports.toml file.

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

Examples

Checkout the netlify branch to find the code behind https://go.mlcdf.fr/.

Run Locally

Clone the project

git clone https://github.com/mlcdf/vanity-imports.git

Go to the project directory

cd vanity-imports

Generate the pages

go run .

View the output on your browser

cd dist
python3 -m http.server 8000
# open your browser to localhost:8000

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL