paivalehti

Documentation

Index

• Constants
• type Config
  • func ConfigFromRoot(root string) (Config, error)
• type FrontMatter
• type Item
• type YAMLTime
  • func NewYAMLTime(t time.Time) YAMLTime
  • func (yt YAMLTime) MarshalYAML() (interface{}, error)
  • func (yt YAMLTime) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const DefaultOrganization = `{{ .Kind }}s/{{ .Posted.Format "2006-01-02" }}`

DefaultOrganization shows where to put files if organization is unset

const HTML = "html"

HTML signifies a webpage

const HTMLBegin = "<!--"

const HTMLSeparator = "-->"

const Markdown = "markdown"

Markdown signifies markdown

const MarkdownSeparator = "\n---\n"

MarkdownSeparator separates YAML documents

Types

type Config

type Config struct {
	Root string

	Title       string
	Subtitle    string
	Description string

	In    string
	Out   string
	Theme string

	Organization map[string]string
}

Config is site configuration

func ConfigFromRoot

func ConfigFromRoot(root string) (Config, error)

ConfigFromRoot returns the sites configuration

type FrontMatter

type FrontMatter struct {
	// Kind is what kind of post this is. See ValidKinds (required)
	Kind string

	// Draft is if the page is a draft (do not publish)
	Draft bool

	// Posted is when was the content posted
	Posted YAMLTime `yaml:`

	// Title is a title of this post. (optional)
	Title string `yaml:",omitempty"`

	// Description is a short description of the post. (optional)
	Description string `yaml:",omitempty"`

	// Source is where the post content originated from
	Source string `yaml:",omitempty"`
}

FrontMatter is what gets stored in the header of an item (or in YAML sidecar)

type Item

type Item struct {
	FrontMatter FrontMatter
	// Content is inline content
	Content string
	// Path is where the input is saved on disk
	Path string
	// RelPath is where the item was found relative to the input directory
	RelPath string
	// Format is the format to store in
	Format string
}

Item is a post to be rendered

type YAMLTime

type YAMLTime struct {
	time.Time
}

func NewYAMLTime

func NewYAMLTime(t time.Time) YAMLTime

func (YAMLTime) MarshalYAML

func (yt YAMLTime) MarshalYAML() (interface{}, error)

func (YAMLTime) UnmarshalYAML

func (yt YAMLTime) UnmarshalYAML(unmarshal func(interface{}) error) error