booklitdoc

Documentation

Index

• func NewPlugin(section *booklit.Section) booklit.Plugin
• type Plugin
  • func (plugin Plugin) ColumnHeader(content booklit.Content) booklit.Content
  • func (plugin Plugin) Columns(title booklit.Content, rest ...booklit.Content) booklit.Content
  • func (plugin Plugin) Define(node ast.Node, content booklit.Content) (booklit.Content, error)
  • func (plugin Plugin) DescribeFruit(name string, definition booklit.Content, tags ...string) (booklit.Content, error)
  • func (plugin Plugin) Godoc(ref string) (booklit.Content, error)
  • func (plugin Plugin) LitSyntax(code booklit.Content) (booklit.Content, error)
  • func (plugin Plugin) OutputFrame(url string) booklit.Content
  • func (plugin Plugin) SyntaxHl(content booklit.Content) booklit.Content
  • func (plugin Plugin) TemplateLink(tmpl string) (booklit.Content, error)

Functions

func NewPlugin

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

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func (Plugin) ColumnHeader

func (plugin Plugin) ColumnHeader(content booklit.Content) booklit.Content

func (Plugin) Columns

func (plugin Plugin) Columns(title booklit.Content, rest ...booklit.Content) booklit.Content

func (Plugin) Define

func (plugin Plugin) Define(node ast.Node, content booklit.Content) (booklit.Content, error)

func (Plugin) DescribeFruit

func (plugin Plugin) DescribeFruit(
	name string,
	definition booklit.Content,
	tags ...string,
) (booklit.Content, error)

func (Plugin) Godoc

func (plugin Plugin) Godoc(ref string) (booklit.Content, error)

func (Plugin) LitSyntax

func (plugin Plugin) LitSyntax(code booklit.Content) (booklit.Content, error)

func (Plugin) OutputFrame

func (plugin Plugin) OutputFrame(url string) booklit.Content

func (Plugin) SyntaxHl

func (plugin Plugin) SyntaxHl(content booklit.Content) booklit.Content

func (Plugin) TemplateLink

func (plugin Plugin) TemplateLink(tmpl string) (booklit.Content, error)