metadata

Documentation

Overview

Package metadata provides functionality for generating, parsing and operating on Front Matter metadata within Markdown files.

Index

• func Generate() string
• type Fields
  • func Parse(cfg config.Config, filename string) (Fields, error)
  • func (f Fields) Validate() error

Functions

func Generate

func Generate() string

Generate returns a string repesentation of the Front Matter metadata block to be included within a new note file.

Types

type Fields

type Fields struct {
	ID      string `yaml:"id"`
	Created string `yaml:"created"`
}

Fields are the different values within the Front Matter block at the top of any note.

func Parse

func Parse(cfg config.Config, filename string) (Fields, error)

Parse decodes the values within the Front Matter block at the top of the note at the given filepath, and returns them as a metadata.Fields type.

func (Fields) Validate

func (f Fields) Validate() error

Validate checks that the values within the Front Matter metadata block valid.