docs

Documentation

Index

• type Categories
  • func (cs Categories) Find(slug string) Category
• type Category
• type Document
  • func (d *Document) Category() Category
  • func (d *Document) Level() int
• type Documents
  • func Load(box packr.Box) (*Documents, error)
  • func (ds *Documents) Add(d Document) error
  • func (ds *Documents) Breadcrumbs(slug string) []string
  • func (ds *Documents) Categories() Categories
  • func (ds *Documents) Children(slug string) []Document
  • func (ds *Documents) Find(slug string) (*Document, bool)
  • func (ds *Documents) UploadIndex() error

Types

type Categories

type Categories []Category

func (Categories) Find

func (cs Categories) Find(slug string) Category

type Category

type Category struct {
	Slug string
	Name string
}

type Document

type Document struct {
	Body        []byte
	Description string
	Order       int
	Path        string
	Slug        string
	Tags        []string
	Title       string
}

func (*Document) Category

func (d *Document) Category() Category

func (*Document) Level

func (d *Document) Level() int

type Documents

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

func Load

func Load(box packr.Box) (*Documents, error)

func (*Documents) Add

func (ds *Documents) Add(d Document) error

func (*Documents) Breadcrumbs

func (ds *Documents) Breadcrumbs(slug string) []string

func (*Documents) Categories

func (ds *Documents) Categories() Categories

func (*Documents) Children

func (ds *Documents) Children(slug string) []Document

func (*Documents) Find

func (ds *Documents) Find(slug string) (*Document, bool)

func (*Documents) UploadIndex

func (ds *Documents) UploadIndex() error