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

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

func (*HTMLRenderingEngine) URL

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

func (*HTMLRenderingEngine) VisitDefinitions

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

func (*HTMLRenderingEngine) VisitImage

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

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

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

type SearchIndex map[string]SearchDocument

type TextRenderingEngine

type TextRenderingEngine struct {

	// contains filtered or unexported fields

}

func NewTextRenderingEngine

func NewTextRenderingEngine(fileExtension string) *TextRenderingEngine

func (*TextRenderingEngine) FileExtension

func (engine *TextRenderingEngine) FileExtension() string

func (*TextRenderingEngine) LoadTemplates

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

func (*TextRenderingEngine) RenderSection

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

func (*TextRenderingEngine) URL

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

func (*TextRenderingEngine) VisitDefinitions

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

func (*TextRenderingEngine) VisitImage

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

func (*TextRenderingEngine) VisitList

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

func (*TextRenderingEngine) VisitParagraph

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

func (*TextRenderingEngine) VisitPreformatted

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

func (*TextRenderingEngine) VisitReference

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

func (*TextRenderingEngine) VisitSection

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

func (*TextRenderingEngine) VisitSequence

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

func (*TextRenderingEngine) VisitString

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

func (*TextRenderingEngine) VisitStyled

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

func (*TextRenderingEngine) VisitTable

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

func (*TextRenderingEngine) VisitTableOfContents

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

func (*TextRenderingEngine) VisitTarget

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

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

func (Writer) WriteSection

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

Directories

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