hugo

Documentation

Index

• type FMInvalidTypeError
  • func NewFMInvalidTypeError(fmKey, wantType string, got interface{}) *FMInvalidTypeError
  • func (e *FMInvalidTypeError) Error() string
• type FMNotExistError
  • func NewFMNotExistError(fmKey string) *FMNotExistError
  • func (e *FMNotExistError) Error() string
• type FrontMatter
  • func ParseFrontMatter(filename string) (*FrontMatter, error)

Types

type FMInvalidTypeError

type FMInvalidTypeError struct {
	Key      string
	WantType string
	Got      interface{}
}

FMInvalidTypeError is an error that means the front-matter type is invalid.

func NewFMInvalidTypeError

func NewFMInvalidTypeError(fmKey, wantType string, got interface{}) *FMInvalidTypeError

func (*FMInvalidTypeError) Error

func (e *FMInvalidTypeError) Error() string

type FMNotExistError

type FMNotExistError struct {
	Key string
}

FMNotExistError is an error that means the front-matter key/value is not exists in the content file.

func NewFMNotExistError

func NewFMNotExistError(fmKey string) *FMNotExistError

func (*FMNotExistError) Error

func (e *FMNotExistError) Error() string

type FrontMatter

type FrontMatter struct {
	Title    string
	Author   string
	Category string
	Tags     []string
	Date     time.Time
}

func ParseFrontMatter

func ParseFrontMatter(filename string) (*FrontMatter, error)

ParseFrontMatter parses the frontmatter of the specified Hugo content.