slimdown

README

golang-slimdown

This package allows a subset of Markdown to be compiled into HTML.

Information

The code is still a work in progress. Use at your own risk.

Documentation

Index

• Variables
• func Compile(input []byte, options *Options) (output template.HTML, err error)
• func CompileDefault(input []byte) (output template.HTML, err error)
• func CompileString(input string, options *Options) (output template.HTML, err error)
• func CompileStringDefault(input string) (output template.HTML, err error)
• type Options

Variables

var (
	ErrCompileTokenStackOverflow        = errors.New("token stack overflow") // unused
	ErrCompileTokenTypeUnknown          = errors.New("token type unknown")
	ErrCompileBackslashTransformUnknown = errors.New("backslash transform unknown")
)

var (
	DefaultOptions = Options{
		AllowHTML:                 false,
		CleanEmptyTags:            false,
		CleanEmptyTokens:          false,
		DebugPrintOutput:          false,
		DebugPrintTokens:          false,
		EnableBackslashTransforms: false,
		EnableBlockquotes:         false,
		EnableCodeTags:            true,
		EnableDocumentTags:        false,
		EnableEmTags:              true,
		EnableHeadings:            true,
		EnableHorizontalRules:     true,
		EnableHyphenTransforms:    true,
		EnableImages:              true,
		EnableLinks:               true,
		EnableLists:               true,
		EnableParagraphs:          true,
		EnableStrongTags:          true,
		MaxConsecutiveTabs:        0,
		MaxConsecutiveSpaces:      0,
		SpacesToTab:               0,
		TabToSpaces:               0,
	}
)

Functions

func Compile

func Compile(input []byte, options *Options) (output template.HTML, err error)

func CompileDefault

func CompileDefault(input []byte) (output template.HTML, err error)

func CompileString

func CompileString(input string, options *Options) (output template.HTML, err error)

func CompileStringDefault

func CompileStringDefault(input string) (output template.HTML, err error)

Types

type Options

type Options struct {
	AllowHTML                 bool
	CleanEmptyTags            bool
	CleanEmptyTokens          bool
	DebugPrintOutput          bool
	DebugPrintTokens          bool
	EnableBackslashTransforms bool
	EnableBlockquotes         bool
	EnableCodeTags            bool
	EnableDocumentTags        bool
	EnableEmTags              bool
	EnableHeadings            bool
	EnableHorizontalRules     bool
	EnableHyphenTransforms    bool
	EnableImages              bool
	EnableLinks               bool
	EnableLists               bool
	EnableMarkTags            bool
	EnableParagraphs          bool
	EnableStrongTags          bool
	MaxConsecutiveTabs        int
	MaxConsecutiveSpaces      int
	SpacesToTab               int
	TabToSpaces               int
	// contains filtered or unexported fields
}