matter

Documentation

Index

• func AddDateTimeLayout(layout string)
• func MakeFrontMatterStanza(fmt FrontMatterType, ctx context.Context) (stanza string)
• 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 NewPageMatter(origin string, path, body string, frontMatterType FrontMatterType, ...) (pm *PageMatter)
  • func ParsePageMatter(origin string, path string, created, updated time.Time, raw []byte) (pm *PageMatter, err error)
  • func (pm *PageMatter) Bytes() (data []byte, err error)
  • func (pm *PageMatter) DecodeJsonBody() (data beContext.Context, err error)
  • func (pm *PageMatter) DecodeJsonBodyWith(v interface{}) (err error)

Functions

func AddDateTimeLayout

func AddDateTimeLayout(layout string)

func MakeFrontMatterStanza

func MakeFrontMatterStanza(fmt FrontMatterType, ctx context.Context) (stanza string)

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 {
	Origin string

	Path   string
	Shasum string

	Body   string
	Matter beContext.Context
	Locale language.Tag

	Created time.Time
	Updated time.Time

	FrontMatter     string
	FrontMatterType FrontMatterType

	Stub interface{}
}

func NewPageMatter

func NewPageMatter(origin string, path, body string, frontMatterType FrontMatterType, matter beContext.Context) (pm *PageMatter)

func ParsePageMatter

func ParsePageMatter(origin string, 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

func (*PageMatter) DecodeJsonBody

func (pm *PageMatter) DecodeJsonBody() (data beContext.Context, err error)

DecodeJsonBody decodes the .Body from JSON and returns the context data

func (*PageMatter) DecodeJsonBodyWith

func (pm *PageMatter) DecodeJsonBodyWith(v interface{}) (err error)