markdown

README

Folder information

This folder contains the markdown/blackfriday cross-framework template engine support.

Documentation

Index

• type Config
  • func DefaultConfig() Config
• type Engine
  • func New(cfg ...Config) *Engine
  • func (e *Engine) ExecuteRaw(src string, wr io.Writer, binding interface{}) (err error)
  • func (e *Engine) ExecuteWriter(out io.Writer, name string, binding interface{}, ...) error
  • func (e *Engine) LoadAssets(virtualDirectory string, virtualExtension string, ...) error
  • func (e *Engine) LoadDirectory(dir string, extension string) error

Types

type Config

type Config struct {
	// Sanitize if true then returns safe html, default is false
	Sanitize bool
}

Config for markdown template engine

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configs for the markdown template engine

type Engine

type Engine struct {
	Config Config
	// contains filtered or unexported fields
}

Engine the jade engine

func New

func New(cfg ...Config) *Engine

New creates and returns a Pongo template engine

func (*Engine) ExecuteRaw

func (e *Engine) ExecuteRaw(src string, wr io.Writer, binding interface{}) (err error)

ExecuteRaw receives, parse and executes raw source template contents it's super-simple function without options and funcs, it's not used widely implements the EngineRawExecutor interface

func (*Engine) ExecuteWriter

func (e *Engine) ExecuteWriter(out io.Writer, name string, binding interface{}, options ...map[string]interface{}) error

ExecuteWriter executes a templates and write its results to the out writer layout here is useless

func (*Engine) LoadAssets

func (e *Engine) LoadAssets(virtualDirectory string, virtualExtension string, assetFn func(name string) ([]byte, error), namesFn func() []string) error

LoadAssets loads the templates by binary

func (*Engine) LoadDirectory

func (e *Engine) LoadDirectory(dir string, extension string) error

LoadDirectory builds the markdown templates