canonical-gen

command module
v0.0.0-...-8a70eea Latest Latest
Warning

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

Go to latest
Published: Jul 9, 2017 License: BSD-2-Clause Imports: 8 Imported by: 0

README

canonical-gen

Build Status Report card codecov

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

Jump to

Keyboard shortcuts

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