canonical-gen

README

canonical-gen

Generate html for use with canonical import paths of Go packages. See go doc for details of canonical import paths and go packages.

Install:

go get -u gangleri.io/pkg/canonical-gen

Usage: From the root of the package you wish to publish run canonical-gen, this will write the HTML to stdout; you can redirect to any file location you like.

e.g.

canonical-gen > index.html

The default behavior is to get the package import path and the repository URL from the root directory of the package code. However, you can change this using the following arguments:

Flag	Description
-pkg	The package import name
-repo	The repository URL
-type	The repository type, defaults to git

Documentation

Overview

package caninical-gen is a cli tool that generates the HTML needed to publish a Golang package using a Canonical import path