preprocessor

Documentation

Index

• type Preprocessor
  • func New(logger logger.Logger, imageProvider *imageprovider.ImageProvider) *Preprocessor
  • func (preprocessor *Preprocessor) Convert(aliasResolver func(alias string) *model.Item, pathProvider paths.Pather, ...) (processedMarkdown string, errors error)

Types

type Preprocessor

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

Preprocessor provides pre-processing capabilties for markdown code.

func New

func New(logger logger.Logger, imageProvider *imageprovider.ImageProvider) *Preprocessor

New creates an instance of a Markdown Preprocessor.

func (*Preprocessor) Convert

func (preprocessor *Preprocessor) Convert(
	aliasResolver func(alias string) *model.Item,
	pathProvider paths.Pather,
	itemRoute route.Route,
	files []*model.File,
	markdown string) (processedMarkdown string, errors error)

Convert converts all markdown extensions in the supplied markdown to normal markdown code or HTML.