markdown

Documentation

Overview

Package markdown is the expander for markdown to html

Index

• Variables
• type Markdown
  • func New(layoutKey, htmlKey, contentKey string, list gen.List) *Markdown
  • func (m *Markdown) Expand(p []byte, v gen.Variables) ([]byte, error)
  • func (_ *Markdown) Ext() (string, string)

Variables

var (
	// ErrLayoutFileNotFound is retunred when layout file is not found in list
	ErrLayoutFileNotFound = errors.New("No such layout file is found")
)

Types

type Markdown

type Markdown struct {
	LayoutKey  string
	HTMLKey    string
	ContentKey string
	List       gen.List
}

Markdown satisfies gen.Expander

func New

func New(layoutKey, htmlKey, contentKey string, list gen.List) *Markdown

New returns new instance of Markdown. layoutKey is ident of layout file in markdown file. htmlKey is Variables key of content for html loader. contentKey is content ident in html file for markdown content.

func (*Markdown) Expand

func (m *Markdown) Expand(p []byte, v gen.Variables) ([]byte, error)

Expand implements gen.Expander

func (*Markdown) Ext

func (_ *Markdown) Ext() (string, string)

Ext implements gen.Expander