pql

Documentation

Index

• Variables
• func BaseIncludeContextKeys() []string
• func MustExcludeContextKeys() []string

Variables

var (
	// AlwaysExcludeContextKeys is a pages-pql package-wide setting for a list
	// of keys to always exclude, in addition to the MustExcludeContextKeys
	AlwaysExcludeContextKeys []string

	// AlwaysIncludeContextKeys is a pages-pql package-wide setting for a list
	// of keys to always include, in addition to those specified during the
	// feature build phase with IncludeContextKeys or SetIncludedContextKeys
	AlwaysIncludeContextKeys []string
)

Functions

func BaseIncludeContextKeys

func BaseIncludeContextKeys() []string

BaseIncludeContextKeys returns the default list of included context keys for Page Query Language purposes; these keys are currently: "Type", "Language", "Url", "Title" and "Description"

func MustExcludeContextKeys

func MustExcludeContextKeys() []string

MustExcludeContextKeys returns the list of context keys that should never be indexed for Page Query Language purposes; these keys are currently: "Content" and "FrontMatter"