md

Documentation

Index

• type AtxHeaderBlock
• type AutomaticLink
• type Code
• type CodeBlock
• type Emphasis
• type End
• type HorizontalRuleBlock
• type Image
• type ItemBlock
• type Link
• type NullBlock
• type OrderedListBlock
• type ParagraphBlock
• type Prose
  • func (p Prose) GetProse() Region
• type Proser
• type QuoteBlock
• type Raw
  • func (r Raw) GetRaw() Region
• type ReferenceResolutionBlock
• type Region
• type Run
• type SetextHeaderBlock
• type Tag
• type UnorderedListBlock

Types

type AtxHeaderBlock

type AtxHeaderBlock struct {
	Level int
	Raw
}

type AutomaticLink

type AutomaticLink struct{ URL, Text string }

type Code

type Code struct{ Code []byte }

type CodeBlock

type CodeBlock struct {
	Prose
	Raw
}

type Emphasis

type Emphasis struct{ Level int }

type End

type End struct{}

type HorizontalRuleBlock

type HorizontalRuleBlock struct {
	Raw
}

type Image

type Image struct {
	ReferenceID string
	URL         string
	Title       string
	AltText     string
	RawEnd      Raw
}

type ItemBlock

type ItemBlock struct {
	Raw
}

type Link

type Link struct {
	ReferenceID, URL, Title string
	RawEnd                  Raw
}

type NullBlock

type NullBlock struct {
	Raw
}

type OrderedListBlock

type OrderedListBlock struct {
	Starter Run
	Raw
}

type ParagraphBlock

type ParagraphBlock struct {
	Raw
}

type Prose

type Prose Region

func (Prose) GetProse

func (p Prose) GetProse() Region

type Proser

type Proser interface {
	GetProse() Region
}

type QuoteBlock

type QuoteBlock struct {
	Raw
}

type Raw

type Raw Region

func (Raw) GetRaw

func (r Raw) GetRaw() Region

type ReferenceResolutionBlock

type ReferenceResolutionBlock struct {
	ReferenceID string
	URL, Title  string
	Raw
}

type Region

type Region []Run

type Run

type Run struct {
	Line  int
	Bytes []byte // with Line, allows to find out position in line
}

TODO(akavel): rename Run to something prettier?

type SetextHeaderBlock

type SetextHeaderBlock struct {
	Level int
	Raw
}

type Tag

type Tag interface{}

type UnorderedListBlock

type UnorderedListBlock struct {
	Starter Run
	Raw
}