render

package

Go to main page

Versions in this module

v0

v0.12.1

Dec 29, 2021

v0.12.0

Feb 7, 2021

Changes in this version

+ var HTMLFuncs = template.FuncMap

+ var TextFuncs = template.FuncMap

+ type Engine interface

+ FileExtension func() string

+ RenderSection func(io.Writer, *booklit.Section) error

+ URL func(booklit.Tag) string

+ type HTMLEngine struct

+ func NewHTMLEngine() *HTMLEngine

+ func (engine *HTMLEngine) FileExtension() string

+ func (engine *HTMLEngine) LoadTemplates(templatesDir string) error

+ func (engine *HTMLEngine) RenderSection(out io.Writer, con *booklit.Section) error

+ func (engine *HTMLEngine) URL(tag booklit.Tag) string

+ func (engine *HTMLEngine) VisitDefinitions(con booklit.Definitions) error

+ func (engine *HTMLEngine) VisitImage(con booklit.Image) error

+ func (engine *HTMLEngine) VisitLink(con booklit.Link) error

+ func (engine *HTMLEngine) VisitList(con booklit.List) error

+ func (engine *HTMLEngine) VisitParagraph(con booklit.Paragraph) error

+ func (engine *HTMLEngine) VisitPreformatted(con booklit.Preformatted) error

+ func (engine *HTMLEngine) VisitReference(con *booklit.Reference) error

+ func (engine *HTMLEngine) VisitSection(con *booklit.Section) error

+ func (engine *HTMLEngine) VisitSequence(con booklit.Sequence) error

+ func (engine *HTMLEngine) VisitString(con booklit.String) error

+ func (engine *HTMLEngine) VisitStyled(con booklit.Styled) error

+ func (engine *HTMLEngine) VisitTable(con booklit.Table) error

+ func (engine *HTMLEngine) VisitTableOfContents(con booklit.TableOfContents) error

+ func (engine *HTMLEngine) VisitTarget(con booklit.Target) error

+ type TextEngine struct

+ func NewTextEngine(fileExtension string) *TextEngine

+ func (engine *TextEngine) FileExtension() string

+ func (engine *TextEngine) LoadTemplates(templatesDir string) error

+ func (engine *TextEngine) RenderSection(out io.Writer, con *booklit.Section) error

+ func (engine *TextEngine) URL(tag booklit.Tag) string

+ func (engine *TextEngine) VisitDefinitions(con booklit.Definitions) error

+ func (engine *TextEngine) VisitImage(con booklit.Image) error

+ func (engine *TextEngine) VisitLink(con booklit.Link) error

+ func (engine *TextEngine) VisitList(con booklit.List) error

+ func (engine *TextEngine) VisitParagraph(con booklit.Paragraph) error

+ func (engine *TextEngine) VisitPreformatted(con booklit.Preformatted) error

+ func (engine *TextEngine) VisitReference(con *booklit.Reference) error

+ func (engine *TextEngine) VisitSection(con *booklit.Section) error

+ func (engine *TextEngine) VisitSequence(con booklit.Sequence) error

+ func (engine *TextEngine) VisitString(con booklit.String) error

+ func (engine *TextEngine) VisitStyled(con booklit.Styled) error

+ func (engine *TextEngine) VisitTable(con booklit.Table) error

+ func (engine *TextEngine) VisitTableOfContents(con booklit.TableOfContents) error

+ func (engine *TextEngine) VisitTarget(con booklit.Target) error

v0.11.0

May 8, 2020

v0.10.0

Apr 16, 2019

Changes in this version

+ type TextRenderingEngine struct

+ func NewTextRenderingEngine(fileExtension string) *TextRenderingEngine

+ func (engine *TextRenderingEngine) FileExtension() string

+ func (engine *TextRenderingEngine) LoadTemplates(templatesDir string) error

+ func (engine *TextRenderingEngine) RenderSection(out io.Writer, con *booklit.Section) error

+ func (engine *TextRenderingEngine) URL(tag booklit.Tag) string

+ func (engine *TextRenderingEngine) VisitDefinitions(con booklit.Definitions) error

+ func (engine *TextRenderingEngine) VisitImage(con booklit.Image) error

+ func (engine *TextRenderingEngine) VisitLink(con booklit.Link) error

+ func (engine *TextRenderingEngine) VisitList(con booklit.List) error

+ func (engine *TextRenderingEngine) VisitParagraph(con booklit.Paragraph) error

+ func (engine *TextRenderingEngine) VisitPreformatted(con booklit.Preformatted) error

+ func (engine *TextRenderingEngine) VisitReference(con *booklit.Reference) error

+ func (engine *TextRenderingEngine) VisitSection(con *booklit.Section) error

+ func (engine *TextRenderingEngine) VisitSequence(con booklit.Sequence) error

+ func (engine *TextRenderingEngine) VisitString(con booklit.String) error

+ func (engine *TextRenderingEngine) VisitStyled(con booklit.Styled) error

+ func (engine *TextRenderingEngine) VisitTable(con booklit.Table) error

+ func (engine *TextRenderingEngine) VisitTableOfContents(con booklit.TableOfContents) error

+ func (engine *TextRenderingEngine) VisitTarget(con booklit.Target) error

v0.9.0

Apr 16, 2019

v0.8.0

Mar 12, 2019

Changes in this version

type Writer

+ func (writer Writer) WriteSearchIndex(section *booklit.Section, path string) error

v0.7.0

Mar 4, 2019

v0.6.0

Nov 9, 2018

Changes in this version

+ const SearchIndexFilename

type HTMLRenderingEngine

+ func (engine *HTMLRenderingEngine) RenderSection(out io.Writer, con *booklit.Section) error

+ func (engine *HTMLRenderingEngine) URL(tag booklit.Tag) string

+ func (engine *HTMLRenderingEngine) VisitDefinitions(con booklit.Definitions) error

+ func (engine *HTMLRenderingEngine) VisitImage(con booklit.Image) error

+ func (engine *HTMLRenderingEngine) VisitTable(con booklit.Table) error

type RenderingEngine

+ RenderSection func(io.Writer, *booklit.Section) error

+ URL func(booklit.Tag) string

+ type SearchDocument struct

+ Depth int

+ Location string

+ SectionTag string

+ Text string

+ Title string

+ type SearchIndex map[string]SearchDocument

type Writer

+ SaveSearchIndex bool

v0.0.1

Jul 12, 2017

Changes in this version

+ func Asset(name string) ([]byte, error)

+ func AssetDir(name string) ([]string, error)

+ func AssetInfo(name string) (os.FileInfo, error)

+ func AssetNames() []string

+ func MustAsset(name string) []byte

+ func RestoreAsset(dir, name string) error

+ func RestoreAssets(dir, name string) error

+ type HTMLRenderingEngine struct

+ func NewHTMLRenderingEngine() *HTMLRenderingEngine

+ func (engine *HTMLRenderingEngine) FileExtension() string

+ func (engine *HTMLRenderingEngine) LoadTemplates(templatesDir string) error

+ func (engine *HTMLRenderingEngine) Render(out io.Writer) error

+ func (engine *HTMLRenderingEngine) VisitBlock(con booklit.Block) error

+ func (engine *HTMLRenderingEngine) VisitLink(con booklit.Link) error

+ func (engine *HTMLRenderingEngine) VisitList(con booklit.List) error

+ func (engine *HTMLRenderingEngine) VisitParagraph(con booklit.Paragraph) error

+ func (engine *HTMLRenderingEngine) VisitPreformatted(con booklit.Preformatted) error

+ func (engine *HTMLRenderingEngine) VisitReference(con *booklit.Reference) error

+ func (engine *HTMLRenderingEngine) VisitSection(con *booklit.Section) error

+ func (engine *HTMLRenderingEngine) VisitSequence(con booklit.Sequence) error

+ func (engine *HTMLRenderingEngine) VisitString(con booklit.String) error

+ func (engine *HTMLRenderingEngine) VisitStyled(con booklit.Styled) error

+ func (engine *HTMLRenderingEngine) VisitTableOfContents(con booklit.TableOfContents) error

+ func (engine *HTMLRenderingEngine) VisitTarget(con booklit.Target) error

+ type RenderingEngine interface

+ FileExtension func() string

+ Render func(io.Writer) error

+ type WalkContext struct

+ Current *booklit.Section

+ Section *booklit.Section

+ type Writer struct

+ Destination string

+ Engine RenderingEngine

+ func (writer Writer) WriteSection(section *booklit.Section) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL