model

Documentation

Index

• Variables
• type Meta
  • func NewMeta(posts, perPage int) *Meta
• type Post
  • func NewPostFromFile(basePath, postPath string, f formatter.Formatter) (*Post, error)
• type Tag

Variables

var (
	// ErrorBadPostStructure is the error returned when trying to load a post with bad internal structure
	ErrorBadPostStructure = errors.New("bad post structure: must be post meta lines, separator, post body. Separator: " + postMetaDelimiter)
	// ErrorBadMetaStructure is the error returned when trying to load a post with bad meta structure
	ErrorBadMetaStructure = errors.New("bad post meta structure, must have the following lines: post title, publishing date, post tags")
)

Types

type Meta

type Meta struct {
	Posts   int
	PerPage int
	Pages   int
}

Meta represents posts metadata model

func NewMeta

func NewMeta(posts, perPage int) *Meta

NewMeta instantiate posts metadata with pre-calculated fields

type Post

type Post struct {
	Path        string `storm:"id"`
	ID          string `storm:"unique"`
	Title       string
	PublishedAt time.Time `storm:"index"`
	Tags        []string
	Format      string

	Body       string
	BodyHTML   string
	Teaser     string
	TeaserHTML string
}

Post represents post model

func NewPostFromFile

func NewPostFromFile(basePath, postPath string, f formatter.Formatter) (*Post, error)

NewPostFromFile loads new post instance from file

type Tag

type Tag struct {
	Tag   string `storm:"id"`
	Paths []string
}

Tag represents post tag model