rundown

Documentation

Index

• type LoadErrors
  • func (le *LoadErrors) Error() string
• type LoadedDocument
  • func (doc *LoadedDocument) GetInvokes() []*ast.InvokeBlock
  • func (doc *LoadedDocument) GetSections() []*ast.SectionPointer
  • func (d *LoadedDocument) Render(outputStream io.Writer) error
• type LoadedDocuments
  • func Load(filename string) (*LoadedDocuments, error)
  • func LoadString(data string, filename string) (*LoadedDocuments, error)
  • func (doc *LoadedDocuments) GetSections() []*Section
• type Section

Types

type LoadErrors

type LoadErrors []error

func (*LoadErrors) Error

func (le *LoadErrors) Error() string

type LoadedDocument

type LoadedDocument struct {
	Filename string
	Document goldast.Node
	Source   []byte
	Goldmark goldmark.Markdown
	Context  *renderer.Context
}

func (*LoadedDocument) GetInvokes

func (doc *LoadedDocument) GetInvokes() []*ast.InvokeBlock

Walks through the document and returns all the found InvokeBlocks

func (*LoadedDocument) GetSections

func (doc *LoadedDocument) GetSections() []*ast.SectionPointer

Walks through the document and returns all the found SectionPointers

func (*LoadedDocument) Render

func (d *LoadedDocument) Render(outputStream io.Writer) error

type LoadedDocuments

type LoadedDocuments struct {
	MasterDocument    *LoadedDocument
	ImportedDocuments []*LoadedDocument
	Context           *renderer.Context
}

func Load

func Load(filename string) (*LoadedDocuments, error)

func LoadString

func LoadString(data string, filename string) (*LoadedDocuments, error)

func (*LoadedDocuments) GetSections

func (doc *LoadedDocuments) GetSections() []*Section

type Section

type Section struct {
	Pointer  *ast.SectionPointer
	Document *LoadedDocument
}