Documentation

Overview

    Package baselit provides the base plugin used by all sections by default.

    See https://booklit.page/baselit.html for more information.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func NewPlugin

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

    Types

    type Plugin

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

    func (Plugin) Aside

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

    func (Plugin) Aux

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

    func (Plugin) Bold

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

    func (Plugin) Code

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

    func (Plugin) Definition

    func (plugin Plugin) Definition(subject, definition booklit.Content) booklit.Content

    func (Plugin) Definitions

    func (plugin Plugin) Definitions(items ...booklit.Content) (booklit.Content, error)

    func (Plugin) Image

    func (plugin Plugin) Image(path string, description ...string) booklit.Content

    func (Plugin) IncludeSection

    func (plugin Plugin) IncludeSection(path string) error

    func (Plugin) Inset

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

    func (Plugin) Italic

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

    func (Plugin) Larger

    func (plugin Plugin) Larger(content booklit.Content) booklit.Content
    func (plugin Plugin) Link(content booklit.Content, target string) booklit.Content

    func (Plugin) List

    func (plugin Plugin) List(items ...booklit.Content) booklit.Content

    func (Plugin) OmitChildrenFromTableOfContents

    func (plugin Plugin) OmitChildrenFromTableOfContents()

    func (Plugin) OrderedList

    func (plugin Plugin) OrderedList(items ...booklit.Content) booklit.Content

    func (Plugin) Reference

    func (plugin Plugin) Reference(tag string, content ...booklit.Content) booklit.Content

    func (Plugin) Section

    func (plugin Plugin) Section(node ast.Node) error

    func (Plugin) SetPartial

    func (plugin Plugin) SetPartial(name string, content booklit.Content)

    func (Plugin) SinglePage

    func (plugin Plugin) SinglePage()

    func (Plugin) Smaller

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

    func (Plugin) SplitSections

    func (plugin Plugin) SplitSections()

    func (Plugin) Strike

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

    func (Plugin) Styled

    func (plugin Plugin) Styled(name string)

    func (Plugin) Subscript

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

    func (Plugin) Superscript

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

    func (Plugin) Table

    func (plugin Plugin) Table(rows ...booklit.Content) (booklit.Content, error)

    func (Plugin) TableOfContents

    func (plugin Plugin) TableOfContents() booklit.Content

    func (Plugin) TableRow

    func (plugin Plugin) TableRow(cols ...booklit.Content) booklit.Content

    func (Plugin) Target

    func (plugin Plugin) Target(tag string, titleAndContent ...booklit.Content) booklit.Content

    func (Plugin) Title

    func (plugin Plugin) Title(title booklit.Content, tags ...string) error

    func (Plugin) UsePlugin

    func (plugin Plugin) UsePlugin(name string) error

    Source Files