templater

Documentation

Overview

Package templater provides functionality to manage and render templates for Zettelkasten notes.

Index

• Variables
• type SingleTemplate
• type TemplateData
• type TemplateMap
• type Templater
  • func NewTemplater() (*Templater, error)
  • func (t *Templater) Execute(templateName string, data interface{}) (string, error)
  • func (t *Templater) GenerateTagsAndDate(tmplName string) (string, []string)

Variables

var AvailableTemplates = map[string]bool{
	"day":      true,
	"roadmap":  true,
	"zet":      true,
	"project":  true,
	"feature":  true,
	"stack":    true,
	"question": true,
	"version":  true,
	"week":     true,
	"month":    true,
	"echo":     true,
	"sum":      true,
	"year":     true,
}

AvailableTemplates defines the set of templates that are available for use

Types

type SingleTemplate

type SingleTemplate struct {
	FilePath string
	Content  string
	Data     TemplateData
}

type TemplateData

type TemplateData struct {
	Title     string
	Date      string
	Upstream  string
	Content   string
	Tags      []string
	Links     []string
	Fulfilled bool
}

TemplateData defines the structure for data that will be passed to templates during rendering.

type TemplateMap

type TemplateMap map[string]SingleTemplate

type Templater

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

Templater manages a collection of templates.

func NewTemplater

func NewTemplater() (*Templater, error)

func (*Templater) Execute

func (t *Templater) Execute(templateName string, data interface{}) (string, error)

Execute finds the template by name, validates the data against the expected struct, and renders the template.

func (*Templater) GenerateTagsAndDate

func (t *Templater) GenerateTagsAndDate(tmplName string) (string, []string)

GenerateTagsAndDate generates the Zettelkasten-style timestamp and auto-generated tags.