render

Documentation

Index

• func Execute(w io.Writer, fmt string, data interface{}, opt ...Option) error
• func HTML(ctx Context, nodes ...nodes.Node) (htmlTemplate.HTML, error)
• func Lite(ctx Context, nodes ...nodes.Node) (htmlTemplate.HTML, error)
• func MD(ctx Context, nodes ...nodes.Node) (string, error)
• func ReplaceDoubleCurlyBracketsWithEntity(s string) string
• func WriteHTML(w io.Writer, env string, fmt string, nodes ...nodes.Node) error
• func WriteLite(w io.Writer, env string, nodes ...nodes.Node) error
• func WriteMD(w io.Writer, env string, fmt string, nodes ...nodes.Node) error
• type Context
• type Option
  • func WithFuncMap(fm map[string]interface{}) Option

Functions

func Execute

func Execute(w io.Writer, fmt string, data interface{}, opt ...Option) error

Execute renders a template of the fmt format into w.

The fmt argument can also be a path to a local file.

Template execution context data is expected to be of type *Context but can be an arbitrary struct, as long as it contains at least Context's fields for the built-in templates to be successfully executed.

func HTML

func HTML(ctx Context, nodes ...nodes.Node) (htmlTemplate.HTML, error)

HTML renders nodes as the markup for the target env.

func Lite

func Lite(ctx Context, nodes ...nodes.Node) (htmlTemplate.HTML, error)

Lite renders nodes as a standard HTML markup, without Custom Elements.

func MD

func MD(ctx Context, nodes ...nodes.Node) (string, error)

MD renders nodes as markdown for the target env.

func ReplaceDoubleCurlyBracketsWithEntity

func ReplaceDoubleCurlyBracketsWithEntity(s string) string

ReplaceDoubleCurlyBracketsWithEntity replaces Double Curly Brackets with their charater entity.

func WriteHTML

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

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

func WriteLite

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

WriteLite does the same as Lite but outputs rendered markup to w.

func WriteMD

func WriteMD(w io.Writer, env string, fmt string, nodes ...nodes.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
	GlobalGA4 string
	Format    string
	Meta      *types.Meta
	Steps     []*types.Step
	Updated   string
	Extra     map[string]string // Extra variables passed from the command line.
}

Context is a template context during execution.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is the type of optional arguments for Execute.

func WithFuncMap

func WithFuncMap(fm map[string]interface{}) Option

WithFuncMap creates a user-supplied template functions option.