mdtohtml

Documentation

Index

• Variables
• func MdToHTML(md []byte) []byte
• func New() processor.Processor
• type Processor
  • func (p *Processor) AddPage(folder, pagefile string) (m objx.Map, err error)
  • func (p *Processor) CanRenderPage(_ model.Page) bool
  • func (p *Processor) CreateBody(content []byte, _ model.Page) (*processor.Response, error)
  • func (p *Processor) GetPageTemplate(name string) string
  • func (p *Processor) HTMLTemplateName() string
  • func (p *Processor) Name() string

Variables

var (
	//go:embed templates/page.md
	PageMD string
)

Page the page template

Functions

func MdToHTML

func MdToHTML(md []byte) []byte

func New

func New() processor.Processor

New create a new markdown processor

Types

type Processor

type Processor struct {
}

Processor markdown processor for converting a markdown file to html

func (*Processor) AddPage

func (p *Processor) AddPage(folder, pagefile string) (m objx.Map, err error)

AddPage adding the new page

func (*Processor) CanRenderPage

func (p *Processor) CanRenderPage(_ model.Page) bool

CanRenderPage all pages of the processor should be rendered

func (*Processor) CreateBody

func (p *Processor) CreateBody(content []byte, _ model.Page) (*processor.Response, error)

CreateBody interface method to create a html body from a markdown file

func (*Processor) GetPageTemplate

func (p *Processor) GetPageTemplate(name string) string

GetPageTemplate getting the right template for the named page

func (*Processor) HTMLTemplateName

func (p *Processor) HTMLTemplateName() string

HTMLTemplateName returning the used html template

func (*Processor) Name

func (p *Processor) Name() string

Name returning the name of this processor