mdblock

Documentation

Index

• Variables
• func QuickParse(r io.Reader, mode Mode, detectors Detectors, spanDetectors []mdspan.Detector) ([]md.Tag, error)
• type Context
• type Detector
• type DetectorFunc
  • func (f DetectorFunc) Detect(first, second Line, detectors Detectors) Handler
• type Detectors
  • func (ds Detectors) Find(first, second Line) Handler
• type Handler
  • func DetectAtxHeader(first, second Line, detectors Detectors) Handler
  • func DetectCode(first, second Line, detectors Detectors) Handler
  • func DetectHorizontalRule(first, second Line, detectors Detectors) Handler
  • func DetectNull(first, second Line, detectors Detectors) Handler
  • func DetectOrderedList(start, second Line, detectors Detectors) Handler
  • func DetectQuote(first, second Line, detectors Detectors) Handler
  • func DetectReferenceResolution(start, second Line, detectors Detectors) Handler
  • func DetectSetextHeader(first, second Line, detectors Detectors) Handler
  • func DetectUnorderedList(start, second Line, detectors Detectors) Handler
• type HandlerFunc
  • func (f HandlerFunc) Handle(line Line, context Context) (bool, error)
• type Line
  • func (line Line) EOF() bool
• type Mode
• type ParagraphDetector
  • func (p ParagraphDetector) Detect(first, second Line, detectors Detectors) Handler
• type Parser
  • func (p *Parser) Close() error
  • func (p *Parser) WriteLine(line Line) error

Variables

var DefaultDetectors = Detectors{
	DetectorFunc(DetectNull),
	DetectorFunc(DetectReferenceResolution),
	DetectorFunc(DetectSetextHeader),
	DetectorFunc(DetectCode),
	DetectorFunc(DetectAtxHeader),
	DetectorFunc(DetectQuote),
	DetectorFunc(DetectHorizontalRule),
	DetectorFunc(DetectUnorderedList),
	DetectorFunc(DetectOrderedList),
	ParagraphDetector{},
}

DefaultDetectors contains the list of default detectors in order in which they should be normally applied.

Functions

func QuickParse

func QuickParse(r io.Reader, mode Mode, detectors Detectors, spanDetectors []mdspan.Detector) ([]md.Tag, error)

Important: r must be pre-processed with vfmd.QuickPrep or vfmd.Preprocessor

Types

type Context

type Context interface {
	GetMode() Mode
	GetDetectors() Detectors
	GetSpanDetectors() []mdspan.Detector
	Emit(md.Tag)
}

type Detector

type Detector interface {
	Detect(first, second Line, detectors Detectors) Handler
}

type DetectorFunc

type DetectorFunc func(first, second Line, detectors Detectors) Handler

func (DetectorFunc) Detect

func (f DetectorFunc) Detect(first, second Line, detectors Detectors) Handler

type Detectors

type Detectors []Detector

func (Detectors) Find

func (ds Detectors) Find(first, second Line) Handler

type Handler

type Handler interface {
	Handle(Line, Context) (consumed bool, err error)
}

func DetectAtxHeader

func DetectAtxHeader(first, second Line, detectors Detectors) Handler

func DetectCode

func DetectCode(first, second Line, detectors Detectors) Handler

func DetectHorizontalRule

func DetectHorizontalRule(first, second Line, detectors Detectors) Handler

func DetectNull

func DetectNull(first, second Line, detectors Detectors) Handler

func DetectOrderedList

func DetectOrderedList(start, second Line, detectors Detectors) Handler

func DetectQuote

func DetectQuote(first, second Line, detectors Detectors) Handler

func DetectReferenceResolution

func DetectReferenceResolution(start, second Line, detectors Detectors) Handler

func DetectSetextHeader

func DetectSetextHeader(first, second Line, detectors Detectors) Handler

func DetectUnorderedList

func DetectUnorderedList(start, second Line, detectors Detectors) Handler

type HandlerFunc

type HandlerFunc func(Line, Context) (consumed bool, err error)

func (HandlerFunc) Handle

func (f HandlerFunc) Handle(line Line, context Context) (bool, error)

type Line

type Line md.Run

Line is a Run that may have at most one '\n', as last byte

func (Line) EOF

func (line Line) EOF() bool

type Mode

type Mode int

const (
	// TODO(akavel): make sure they're ordered & named as I wanted
	BlocksAndSpans Mode = iota
	BlocksOnly
	TopBlocks
)

type ParagraphDetector

type ParagraphDetector struct {
	InQuote bool
	InList  bool
}

func (ParagraphDetector) Detect

func (p ParagraphDetector) Detect(first, second Line, detectors Detectors) Handler

type Parser

type Parser struct {
	Context
	// contains filtered or unexported fields
}

func (*Parser) Close

func (p *Parser) Close() error

func (p *Parser) Emit(tag Tag) { unstack(); p.Context.Emit(tag) }

func (*Parser) WriteLine

func (p *Parser) WriteLine(line Line) error