plugin

Documentation

Index

• func Init(section *booklit.Section) booklit.Plugin
• type Plugin
  • func (plugin *Plugin) B(content booklit.Content) booklit.Content
  • func (plugin *Plugin) Bass(code booklit.Content) (booklit.Content, error)
  • func (plugin *Plugin) BassAutolink(code booklit.Content) (booklit.Content, error)
  • func (plugin *Plugin) BassLiterate(alternating ...booklit.Content) (booklit.Content, error)
  • func (plug *Plugin) Commands(commandBlock booklit.Content) (booklit.Content, error)
  • func (*Plugin) Construction(content booklit.Content) booklit.Content
  • func (plugin *Plugin) Demo(demoFn string) booklit.Content
  • func (plugin *Plugin) DemoLiterate(name booklit.Content, literate ...booklit.Content) (booklit.Content, error)
  • func (plugin *Plugin) Demos(demos ...booklit.Content) booklit.Content
  • func (plugin *Plugin) GroundDocs() (booklit.Content, error)
  • func (plugin *Plugin) ScriptDocs() (booklit.Content, error)
  • func (*Plugin) SideBySide(content ...booklit.Content) booklit.Content
  • func (plugin *Plugin) StdlibDocs(name string, source booklit.Content) (booklit.Content, error)
  • func (plugin *Plugin) Syntax(language string, code booklit.Content) (booklit.Content, error)
  • func (plugin *Plugin) SyntaxTransform(language string, code booklit.Content, chromaStyle *chroma.Style, ...) (booklit.Content, error)
  • func (plugin *Plugin) T(content booklit.Content) booklit.Content
  • func (plug *Plugin) Term(term, definition booklit.Content, literate ...booklit.Content) error
• type Transformer
  • func (t Transformer) TransformAll(str string) booklit.Sequence

Functions

func Init

func Init(section *booklit.Section) booklit.Plugin

Types

type Plugin

type Plugin struct {
	Section *booklit.Section
	Base    *baselit.Plugin
	// contains filtered or unexported fields
}

func (*Plugin) B

func (plugin *Plugin) B(content booklit.Content) booklit.Content

func (*Plugin) Bass

func (plugin *Plugin) Bass(code booklit.Content) (booklit.Content, error)

func (*Plugin) BassAutolink

func (plugin *Plugin) BassAutolink(code booklit.Content) (booklit.Content, error)

func (*Plugin) BassLiterate

func (plugin *Plugin) BassLiterate(alternating ...booklit.Content) (booklit.Content, error)

func (*Plugin) Commands

func (plug *Plugin) Commands(commandBlock booklit.Content) (booklit.Content, error)

func (*Plugin) Construction

func (*Plugin) Construction(content booklit.Content) booklit.Content

func (*Plugin) Demo

func (plugin *Plugin) Demo(demoFn string) booklit.Content

func (*Plugin) DemoLiterate

func (plugin *Plugin) DemoLiterate(name booklit.Content, literate ...booklit.Content) (booklit.Content, error)

func (*Plugin) Demos

func (plugin *Plugin) Demos(demos ...booklit.Content) booklit.Content

func (*Plugin) GroundDocs

func (plugin *Plugin) GroundDocs() (booklit.Content, error)

func (*Plugin) ScriptDocs

func (plugin *Plugin) ScriptDocs() (booklit.Content, error)

func (*Plugin) SideBySide

func (*Plugin) SideBySide(content ...booklit.Content) booklit.Content

func (*Plugin) StdlibDocs

func (plugin *Plugin) StdlibDocs(name string, source booklit.Content) (booklit.Content, error)

func (*Plugin) Syntax

func (plugin *Plugin) Syntax(language string, code booklit.Content) (booklit.Content, error)

func (*Plugin) SyntaxTransform

func (plugin *Plugin) SyntaxTransform(language string, code booklit.Content, chromaStyle *chroma.Style, transformers ...Transformer) (booklit.Content, error)

func (*Plugin) T

func (plugin *Plugin) T(content booklit.Content) booklit.Content

func (*Plugin) Term

func (plug *Plugin) Term(term, definition booklit.Content, literate ...booklit.Content) error

type Transformer

type Transformer struct {
	Pattern   *regexp.Regexp
	Transform func(string) booklit.Content
}

func (Transformer) TransformAll

func (t Transformer) TransformAll(str string) booklit.Sequence