site

Documentation

Index

• type ContentType
• type FrontMatter
  • func (fm *FrontMatter) UnmarshalYAML(unmarshal func(interface{}) error) error
• type IndexPage
• type Page
• type PagerItem
• type Site
  • func FromDir(f *fs.FS, conf *config.SiteConfig, dir string, contentType ContentType) (*Site, error)
  • func (s *Site) AllTags() []string
  • func (s *Site) ByPath(path string) *Page
  • func (s *Site) Rebuild(f *fs.FS, path string) error
• type TagSet
  • func (ts TagSet) Add(tags []string)
  • func (ts TagSet) All() []string

Types

type ContentType

type ContentType int

ContentType blog or docs

const (
	ContentTypeBlog ContentType = iota
	ContentTypeDocs
)

List of content types

type FrontMatter

type FrontMatter struct {
	Time  time.Time
	Title string
	Vars  map[string]interface{}
	Tags  []string
}

FrontMatter is a metadata for Page

func (*FrontMatter) UnmarshalYAML

func (fm *FrontMatter) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type IndexPage

type IndexPage struct {
	PagerItem
	Path  string
	Pages []*Page
	Next  *PagerItem
	Prev  *PagerItem
	Pager []*PagerItem
}

IndexPage is a colleciton of pages with pagination info

type Page

type Page struct {
	Content   []byte
	Summary   []byte
	Link      string
	Name      string
	Truncated bool
	Path      string
	Draft     bool

	Front *FrontMatter
}

Page is a parsed page

type PagerItem

type PagerItem struct {
	Number int
	Link   string
}

PagerItem is a pager entity

type Site

type Site struct {
	Pages      []*Page
	IndexPages []*IndexPage
	TagPages   map[string][]*IndexPage
	Tags       TagSet
	// contains filtered or unexported fields
}

Site is collection of content pages

func FromDir

func FromDir(f *fs.FS, conf *config.SiteConfig, dir string, contentType ContentType) (*Site, error)

FromDir loads Site from given directory, recurcively

func (*Site) AllTags

func (s *Site) AllTags() []string

AllTags returns all tags sorted by popularity desc

func (*Site) ByPath

func (s *Site) ByPath(path string) *Page

ByPath returns page by path

func (*Site) Rebuild

func (s *Site) Rebuild(f *fs.FS, path string) error

Rebuild reloads page from file

type TagSet

type TagSet map[string]struct{}

TagSet is a set of tags

func (TagSet) Add

func (ts TagSet) Add(tags []string)

Add adds tag to set if it not in there

func (TagSet) All

func (ts TagSet) All() []string

All returns slice of all tags