metadata

package
v3.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2025 License: GPL-3.0 Imports: 0 Imported by: 0

Documentation

Overview

Package metadata defines available fields for the frontmatter

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Metadata

type Metadata struct {
	Title       string   `yaml:"title"`
	Description string   `yaml:"description"`
	Date        string   `yaml:"date"`
	DateUpdated string   `yaml:"dateUpdated"`
	Layout      string   `yaml:"layout"`
	Tags        []string `yaml:"tags"`
	Pinned      bool     `yaml:"pinned"`
	Unlisted    bool     `yaml:"unlisted"`
	Draft       bool     `yaml:"draft"`
	TOC         bool     `yaml:"toc"`
	ShowHeader  bool     `yaml:"showHeader"`
}

Metadata contains allowed frontmatter in unmarshalled YAML.

Default values

* Pinned: false

* Unlisted: false

* ShowHeader: true

* Layout: "list"

* Draft: false

* TOC: false

func Default

func Default() *Metadata

Default returns the defaults for unspecified frontmatter field values

Jump to

Keyboard shortcuts

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