partials

package

v1.0.0 Latest Latest Go to latest Published: Dec 20, 2022 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SuCicada/su-hugo

Documentation ¶

Overview ¶

Package partials provides template functions for working with reusable templates.

Index ¶

Variables
type Namespace
- func New(deps *deps.Deps) *Namespace
- func (ns *Namespace) Include(ctx context.Context, name string, contextList ...any) (any, error)
- func (ns *Namespace) IncludeCached(ctx context.Context, name string, context any, variants ...any) (any, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var TestTemplateProvider deps.ResourceProvider

TestTemplateProvider is global deps.ResourceProvider. NOTE: It's currently unused.

Functions ¶

This section is empty.

Types ¶

type Namespace ¶

type Namespace struct {
	// contains filtered or unexported fields
}

Namespace provides template functions for the "templates" namespace.

func New ¶

func New(deps *deps.Deps) *Namespace

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

func (*Namespace) Include ¶

func (ns *Namespace) Include(ctx context.Context, name string, contextList ...any) (any, error)

Include executes the named partial. If the partial contains a return statement, that value will be returned. Else, the rendered output will be returned: A string if the partial is a text/template, or template.HTML when html/template. Note that ctx is provided by Hugo, not the end user.

func (*Namespace) IncludeCached ¶ added in v0.30.1

func (ns *Namespace) IncludeCached(ctx context.Context, name string, context any, variants ...any) (any, error)

IncludeCached executes and caches partial templates. The cache is created with name+variants as the key. Note that ctx is provided by Hugo, not the end user.

Source Files ¶

View all Source files

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