templater

package

v0.1.4 Latest Latest Go to latest Published: May 14, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Paintersrp/an

Links

Open Source Insights

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)

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

templater.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL