render

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2020 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HTMLRenderingEngine 

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

func NewHTMLRenderingEngine 

func NewHTMLRenderingEngine() *HTMLRenderingEngine

func (*HTMLRenderingEngine) FileExtension 

func (engine *HTMLRenderingEngine) FileExtension() string

func (*HTMLRenderingEngine) LoadTemplates 

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

func (*HTMLRenderingEngine) RenderSection added in v0.6.0 

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

func (*HTMLRenderingEngine) URL added in v0.6.0 

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

func (*HTMLRenderingEngine) VisitDefinitions added in v0.6.0 

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

func (*HTMLRenderingEngine) VisitImage added in v0.6.0 

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

func (*HTMLRenderingEngine) VisitList 

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

func (*HTMLRenderingEngine) VisitParagraph 

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

func (*HTMLRenderingEngine) VisitPreformatted 

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

func (*HTMLRenderingEngine) VisitReference 

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

func (*HTMLRenderingEngine) VisitSection 

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

func (*HTMLRenderingEngine) VisitSequence 

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

func (*HTMLRenderingEngine) VisitString 

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

func (*HTMLRenderingEngine) VisitStyled 

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

func (*HTMLRenderingEngine) VisitTable added in v0.6.0 

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

func (*HTMLRenderingEngine) VisitTableOfContents 

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

func (*HTMLRenderingEngine) VisitTarget 

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

type RenderingEngine 

type RenderingEngine interface {
	booklit.Visitor

	FileExtension() string
	RenderSection(io.Writer, *booklit.Section) error
	URL(booklit.Tag) string
}

type SearchDocument added in v0.6.0 

type SearchDocument struct {
	Location   string `json:"location"`
	Title      string `json:"title"`
	Text       string `json:"text"`
	Depth      int    `json:"depth"`
	SectionTag string `json:"section_tag"`
}

type SearchIndex added in v0.6.0 

type SearchIndex map[string]SearchDocument

type TextRenderingEngine added in v0.10.0 

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

func NewTextRenderingEngine added in v0.10.0 

func NewTextRenderingEngine(fileExtension string) *TextRenderingEngine

func (*TextRenderingEngine) FileExtension added in v0.10.0 

func (engine *TextRenderingEngine) FileExtension() string

func (*TextRenderingEngine) LoadTemplates added in v0.10.0 

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

func (*TextRenderingEngine) RenderSection added in v0.10.0 

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

func (*TextRenderingEngine) URL added in v0.10.0 

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

func (*TextRenderingEngine) VisitDefinitions added in v0.10.0 

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

func (*TextRenderingEngine) VisitImage added in v0.10.0 

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

func (*TextRenderingEngine) VisitList added in v0.10.0 

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

func (*TextRenderingEngine) VisitParagraph added in v0.10.0 

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

func (*TextRenderingEngine) VisitPreformatted added in v0.10.0 

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

func (*TextRenderingEngine) VisitReference added in v0.10.0 

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

func (*TextRenderingEngine) VisitSection added in v0.10.0 

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

func (*TextRenderingEngine) VisitSequence added in v0.10.0 

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

func (*TextRenderingEngine) VisitString added in v0.10.0 

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

func (*TextRenderingEngine) VisitStyled added in v0.10.0 

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

func (*TextRenderingEngine) VisitTable added in v0.10.0 

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

func (*TextRenderingEngine) VisitTableOfContents added in v0.10.0 

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

func (*TextRenderingEngine) VisitTarget added in v0.10.0 

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

type WalkContext 

type WalkContext struct {
	Current *booklit.Section
	Section *booklit.Section
}

type Writer 

type Writer struct {
	Engine RenderingEngine

	Destination string
}

func (Writer) WriteSearchIndex added in v0.8.0 

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

func (Writer) WriteSection 

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

Source Files

View all Source files

Directories

Path Synopsis
Code generated for package html by go-bindata DO NOT EDIT.
 Code generated for package html by go-bindata DO NOT EDIT.
Code generated for package text by go-bindata DO NOT EDIT.
 Code generated for package text by go-bindata DO NOT EDIT.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.