processors

Documentation

Index

• type FrontMatter
  • func (f *FrontMatter) Process(documentBlob []byte, node *api.Node) ([]byte, error)
• type Processor
• type ProcessorChain
  • func (p *ProcessorChain) Process(documentBlob []byte, node *api.Node) ([]byte, error)

Types

type FrontMatter

type FrontMatter struct{}

FrontMatter is a processor implementation responsible to inject front-matter properties defined on nodes

func (*FrontMatter) Process

func (f *FrontMatter) Process(documentBlob []byte, node *api.Node) ([]byte, error)

Process implements Processor#Process

type Processor

type Processor interface {
	Process(documentBlob []byte, node *api.Node) ([]byte, error)
}

Processor is used by extensions to transform a document

type ProcessorChain

type ProcessorChain struct {
	Processors []Processor
}

ProcessorChain is a registry of ordered document processors that implements Processor#Process

func (*ProcessorChain) Process

func (p *ProcessorChain) Process(documentBlob []byte, node *api.Node) ([]byte, error)

Process implements Processor#Process invoking the registered chain of Processors sequentially