matter

Documentation

Index

• func AddDateTimeLayout(layout string)
• func AnyStubsInStubs(src, tgt PageStubs) (found bool)
• func ParseDateTime(value string) (t time.Time, err error)
• func ParseJson(content string) (m context.Context, err error)
• func ParseToml(content string) (m context.Context, err error)
• func ParseYaml(content string) (m context.Context, err error)
• type FrontMatterType
  • func ParseFrontMatterContent(raw string) (matter, content string, matterType FrontMatterType)
• type PageMatter
  • func ParsePageMatter(path string, created, updated time.Time, raw []byte) (pm *PageMatter, err error)
  • func (pm *PageMatter) Bytes() (data []byte, err error)
• type PageStub
  • func NewPageStub(enjin beContext.Context, bfs fs.FileSystem, point, source, shasum string, ...) (s *PageStub, err error)
• type PageStubs
  • func (s PageStubs) GetShasum(shasum string) (found *PageStub)
  • func (s PageStubs) GetSource(source string) (found *PageStub)
  • func (s PageStubs) HasShasum(shasum string) (found bool)
  • func (s PageStubs) Random() (stub *PageStub)
• type ValueStubPair

Functions

func AddDateTimeLayout

func AddDateTimeLayout(layout string)

func AnyStubsInStubs

func AnyStubsInStubs(src, tgt PageStubs) (found bool)

func ParseDateTime

func ParseDateTime(value string) (t time.Time, err error)

func ParseJson

func ParseJson(content string) (m context.Context, err error)

func ParseToml

func ParseToml(content string) (m context.Context, err error)

func ParseYaml

func ParseYaml(content string) (m context.Context, err error)

Types

type FrontMatterType

type FrontMatterType string

const (
	TomlMatter FrontMatterType = "toml"
	JsonMatter FrontMatterType = "json"
	YamlMatter FrontMatterType = "yaml"
	NoneMatter FrontMatterType = "none"
)

func ParseFrontMatterContent

func ParseFrontMatterContent(raw string) (matter, content string, matterType FrontMatterType)

type PageMatter

type PageMatter struct {
	Path   string
	Shasum string

	Body   string
	Matter beContext.Context
	Locale language.Tag

	Created time.Time
	Updated time.Time

	FrontMatter     string
	FrontMatterType FrontMatterType

	Stub *PageStub
}

func ParsePageMatter

func ParsePageMatter(path string, created, updated time.Time, raw []byte) (pm *PageMatter, err error)

func (*PageMatter) Bytes

func (pm *PageMatter) Bytes() (data []byte, err error)

Bytes rebuilds the page matter's file data, overriding FrontMatter with the Matter content, in the FrontMatterType format

type PageStub

type PageStub struct {
	Bfs      fs.FileSystem
	Point    string
	Shasum   string
	Source   string
	Language language.Tag
	Fallback language.Tag
	EnjinCtx beContext.Context
}

func NewPageStub

func NewPageStub(enjin beContext.Context, bfs fs.FileSystem, point, source, shasum string, fallback language.Tag) (s *PageStub, err error)

type PageStubs

type PageStubs []*PageStub

func (PageStubs) GetShasum

func (s PageStubs) GetShasum(shasum string) (found *PageStub)

func (PageStubs) GetSource

func (s PageStubs) GetSource(source string) (found *PageStub)

func (PageStubs) HasShasum

func (s PageStubs) HasShasum(shasum string) (found bool)

func (PageStubs) Random

func (s PageStubs) Random() (stub *PageStub)

type ValueStubPair

type ValueStubPair struct {
	Value interface{}
	Stub  *PageStub
}