render

Documentation

Index

• Variables
• type BookInfo
• type BookRendor
  • func New() *BookRendor
  • func (p *BookRendor) Run(book *wabook.Book) error
• type PageInfo
• type SidebarItem
• type SidebarTree
  • func (p SidebarTree) Children(idx int) []int
  • func (p SidebarTree) GenHTML(pageRoot string, pageIndex int) string
  • func (p SidebarTree) Siblings(idx int) []int
• type StaticPageInfo

Variables

var DefaultBookIgnores = []string{
	".git", "_git",
	"book", "book.ini",
	"node_modules",
}

Types

type BookInfo

type BookInfo struct {
	Title           string
	GitRepoIcon     string
	GitRepoUrl      string
	EditUrlTemplate string
	Custom          wabook.CustomConfig
	Giscus          wabook.GiscusConfig
}

type BookRendor

type BookRendor struct {
	Book         *wabook.Book
	BookInfo     *BookInfo
	PageInfos    []*PageInfo
	SidebarItems []*SidebarItem
	Ignores      []string
}

func New

func New() *BookRendor

func (*BookRendor) Run

func (p *BookRendor) Run(book *wabook.Book) error

type PageInfo

type PageInfo struct {
	Index int

	Book            *BookInfo
	SidebarItems    []*SidebarItem
	EditUrlTemplate string

	Root  string
	Path  string
	Title string

	Content string
	RawHtml string

	HasPrev bool
	HasNext bool

	PrevUrl string
	NextUrl string
}

type SidebarItem

type SidebarItem struct {
	Prefix   string
	Number   string // 1.1, 1.2, ...
	Name     string
	Location string
}

type SidebarTree

type SidebarTree []*SidebarItem

func (SidebarTree) Children

func (p SidebarTree) Children(idx int) []int

func (SidebarTree) GenHTML

func (p SidebarTree) GenHTML(pageRoot string, pageIndex int) string

func (SidebarTree) Siblings

func (p SidebarTree) Siblings(idx int) []int

type StaticPageInfo

type StaticPageInfo struct {
	Content string
}