tiffany

README

tiffany

Go vanity URL.

Usage

import "subosito.com/go/tiffany"

For example, you can create a server for your vanity import path:

import (
	"net/http"

	"subosito.com/go/tiffany"
)

func Handler(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Cache-Control", "public, max-age=300")

    tiffany.Render(w, tiffany.Option{
        CanonicalURL: "subosito.com/go/gotenv",
        RepoURL:      "https://github.com/subosito/gotenv",
    })
}

http.Handle("/go/gotenv", Handler)
http.ListenAndServe(":8080", nil)

Documentation

Index

• func Render(w io.Writer, option Option) error
• type Option

Examples

• Render

Functions

func Render

func Render(w io.Writer, option Option) error

Render renders the vanity URL information based on supplied option.

Example

package main

import (
	"fmt"
	"strings"

	"subosito.com/go/tiffany"
)

func main() {
	out := &strings.Builder{}

	tiffany.Render(out, tiffany.Option{
		CanonicalURL: "subosito.com/go/gotenv",
		RepoURL:      "https://github.com/subosito/gotenv",
	})

	fmt.Println(out.String())
}

Types

type Option

type Option struct {
	CanonicalURL     string
	RepoURL          string
	VCS              string
	SourceLayout     string
	SourceURL        string
	GodocURL         string
	GodocDisabled    bool
	RedirectURL      string
	RedirectDisabled bool
}

Option is configuration for vanity URL