hugo: Index | Files

package transform

import ""

Package transform provides template functions for transforming content.


Package Files

init.go remarshal.go transform.go unmarshal.go

type Namespace Uses

type Namespace struct {
    // contains filtered or unexported fields

Namespace provides template functions for the "transform" namespace.

func New Uses

func New(deps *deps.Deps) *Namespace

New returns a new instance of the transform-namespaced template functions.

func (*Namespace) Emojify Uses

func (ns *Namespace) Emojify(s interface{}) (template.HTML, error)

Emojify returns a copy of s with all emoji codes replaced with actual emojis.


func (*Namespace) HTMLEscape Uses

func (ns *Namespace) HTMLEscape(s interface{}) (string, error)

HTMLEscape returns a copy of s with reserved HTML characters escaped.

func (*Namespace) HTMLUnescape Uses

func (ns *Namespace) HTMLUnescape(s interface{}) (string, error)

HTMLUnescape returns a copy of with HTML escape requences converted to plain text.

func (*Namespace) Highlight Uses

func (ns *Namespace) Highlight(s interface{}, lang, opts string) (template.HTML, error)

Highlight returns a copy of s as an HTML string with syntax highlighting applied.

func (*Namespace) Markdownify Uses

func (ns *Namespace) Markdownify(s interface{}) (template.HTML, error)

Markdownify renders a given input from Markdown to HTML.

func (*Namespace) Plainify Uses

func (ns *Namespace) Plainify(s interface{}) (string, error)

Plainify returns a copy of s with all HTML tags removed.

func (*Namespace) Remarshal Uses

func (ns *Namespace) Remarshal(format string, data interface{}) (string, error)

Remarshal is used in the Hugo documentation to convert configuration examples from YAML to JSON, TOML (and possibly the other way around). The is primarily a helper for the Hugo docs site. It is not a general purpose YAML to TOML converter etc., and may change without notice if it serves a purpose in the docs. Format is one of json, yaml or toml.

func (*Namespace) Unmarshal Uses

func (ns *Namespace) Unmarshal(args ...interface{}) (interface{}, error)

Unmarshal unmarshals the data given, which can be either a string, json.RawMessage or a Resource. Supported formats are JSON, TOML, YAML, and CSV. You can optionally provide an options map as the first argument.

Package transform imports 16 packages (graph) and is imported by 44 packages. Updated 2020-07-07. Refresh now. Tools for package owners.