Documentation ¶
Index ¶
- Constants
- 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
- func (engine *HTMLRenderingEngine) FileExtension() string
- func (engine *HTMLRenderingEngine) LoadTemplates(templatesDir string) error
- 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) 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) VisitTable(con booklit.Table) error
- func (engine *HTMLRenderingEngine) VisitTableOfContents(con booklit.TableOfContents) error
- func (engine *HTMLRenderingEngine) VisitTarget(con booklit.Target) error
- type RenderingEngine
- type SearchDocument
- type SearchIndex
- type WalkContext
- type Writer
Constants ¶
const SearchIndexFilename = "search_index.json"
Variables ¶
This section is empty.
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/ foo.txt img/ a.png b.png
then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively
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 (*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 (*HTMLRenderingEngine) VisitLink ¶
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 SearchDocument ¶ added in v0.6.0
type SearchIndex ¶ added in v0.6.0
type SearchIndex map[string]SearchDocument