parser

Documentation

Index

• type DefaultParser
  • func (pp *DefaultParser) Parse(path string, entry fs.FileInfo, context *ParserContext) (tree.Node, error)
  • func (pp *DefaultParser) Test(path string, entry fs.FileInfo) (bool, error)
• type EntryParser
• type PageAttributes
• type Parser
  • func New(opts ...ParserOption) *Parser
  • func (p *Parser) Parse() (*tree.Site, error)
• type ParserContext
  • func (pc *ParserContext) Content(path string) ([]byte, error)
  • func (pc *ParserContext) FrontMatter(path string, output any) error
  • func (pc *ParserContext) Source(path string) ([]byte, error)
• type ParserOption
• type ParserOptionFunc
  • func WithEntryParsers(parsers ...EntryParser) ParserOptionFunc
  • func WithSiteFS(siteFS afero.Fs) ParserOptionFunc
  • func (apply ParserOptionFunc) Apply(p *Parser) error

Types

type DefaultParser

type DefaultParser struct {
}

func (*DefaultParser) Parse

func (pp *DefaultParser) Parse(path string, entry fs.FileInfo, context *ParserContext) (tree.Node, error)

func (*DefaultParser) Test

func (pp *DefaultParser) Test(path string, entry fs.FileInfo) (bool, error)

type EntryParser

type EntryParser interface {
	Test(path string, entry fs.FileInfo) (bool, error)
	Parse(path string, entry fs.FileInfo, context *ParserContext) (tree.Node, error)
}

type PageAttributes

type PageAttributes struct {
	Title    string                 `mapstructure:"title"`
	Meta     []*tree.PageMetaValue  `mapstructure:"meta"`
	Links    []*tree.PageLinksValue `mapstructure:"links"`
	Template string                 `mapstructure:"template"`
}

type Parser

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

func New

func New(opts ...ParserOption) *Parser

func (*Parser) Parse

func (p *Parser) Parse() (*tree.Site, error)

type ParserContext

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

func (*ParserContext) Content

func (pc *ParserContext) Content(path string) ([]byte, error)

func (*ParserContext) FrontMatter

func (pc *ParserContext) FrontMatter(path string, output any) error

func (*ParserContext) Source

func (pc *ParserContext) Source(path string) ([]byte, error)

type ParserOption

type ParserOption interface {
	Apply(*Parser) error
}

type ParserOptionFunc

type ParserOptionFunc func(*Parser) error

func WithEntryParsers

func WithEntryParsers(parsers ...EntryParser) ParserOptionFunc

func WithSiteFS

func WithSiteFS(siteFS afero.Fs) ParserOptionFunc

func (ParserOptionFunc) Apply

func (apply ParserOptionFunc) Apply(p *Parser) error