view

Documentation

Index

• func StripFrontMatter(content []byte) []byte
• type IndexData
  • func (d *IndexData) Map() map[string]any
• type PostData
  • func (d *PostData) Map() map[string]any
• type Views
  • func NewViews(root fs.FS) (*Views, error)
  • func (v *Views) AtomFeed(ctx context.Context, w io.Writer, articles []model.Article) error
  • func (v *Views) Blog(ctx context.Context, w io.Writer, data *IndexData) error
  • func (v *Views) Index(ctx context.Context, w io.Writer, data *IndexData) error
  • func (v *Views) IndexFromArticles(articles []model.Article) *IndexData
  • func (v *Views) Post(ctx context.Context, w io.Writer, data *PostData) error
  • func (v *Views) PostFromArticle(article *model.Article, content string) *PostData

Functions

func StripFrontMatter

func StripFrontMatter(content []byte) []byte

StripFrontMatter removes YAML front matter from content and returns just the body

Types

type IndexData

type IndexData struct {
	Title       string          `json:"title"`
	Description string          `json:"description"`
	OGImage     string          `json:"ogImage"`
	Articles    []model.Article `json:"articles"`
	Total       int             `json:"total"`
}

IndexData holds the data required for rendering the index page

func (*IndexData) Map

func (d *IndexData) Map() map[string]any

Map converts IndexData to a map[string]any

type PostData

type PostData struct {
	Slug        string
	Title       string
	Description string
	OgImage     string
	Content     string
	Date        *time.Time
	Classnames  string
}

PostData holds the data required for rendering the post layout

func (*PostData) Map

func (d *PostData) Map() map[string]any

Map converts PostData to a map[string]any

type Views

type Views struct {
	*layout.Renderer
	// contains filtered or unexported fields
}

func NewViews

func NewViews(root fs.FS) (*Views, error)

func (*Views) AtomFeed

func (v *Views) AtomFeed(ctx context.Context, w io.Writer, articles []model.Article) error

AtomFeed generates an Atom XML feed for articles

func (*Views) Blog

func (v *Views) Blog(ctx context.Context, w io.Writer, data *IndexData) error

Blog renders the blog list page

func (*Views) Index

func (v *Views) Index(ctx context.Context, w io.Writer, data *IndexData) error

Index renders the blog index/list page

func (*Views) IndexFromArticles

func (v *Views) IndexFromArticles(articles []model.Article) *IndexData

IndexFromArticles creates IndexData from a list of articles

func (*Views) Post

func (v *Views) Post(ctx context.Context, w io.Writer, data *PostData) error

Post renders the post layout template

func (*Views) PostFromArticle

func (v *Views) PostFromArticle(article *model.Article, content string) *PostData

PostFromArticle creates PostData from an Article