render

Documentation

Index

• func Execute(w io.Writer, fmt string, ctx *Context) error
• func HTML(env string, nodes ...types.Node) (htmlTemplate.HTML, error)
• func MD(env string, nodes ...types.Node) (string, error)
• func WriteHTML(w io.Writer, env string, nodes ...types.Node) error
• func WriteMD(w io.Writer, env string, nodes ...types.Node) error
• type Context

Functions

func Execute

func Execute(w io.Writer, fmt string, ctx *Context) error

Execute renders a template of the fmt format into w. The fmt argument can also be a path to a local file.

func HTML

func HTML(env string, nodes ...types.Node) (htmlTemplate.HTML, error)

HTML renders nodes as the markup for the target env.

func MD

func MD(env string, nodes ...types.Node) (string, error)

MD renders nodes as markdown for the target env.

func WriteHTML

func WriteHTML(w io.Writer, env string, nodes ...types.Node) error

WriteHTML does the same as HTML but outputs rendered markup to w.

func WriteMD

func WriteMD(w io.Writer, env string, nodes ...types.Node) error

WriteMD does the same as MD but outputs rendered markup to w.

Types

type Context

type Context struct {
	Env      string
	Prefix   string
	GlobalGA string
	Meta     *types.Meta
	Steps    []*types.Step
	Extra    map[string]string // Extra variables passed from the command line.
}

Context is a template context during execution.