gmnhg

Documentation

Index

• func Sort(sortable interface{}) interface{}
• func SortRev(sortable interface{}) interface{}
• type Metadata
  • func ParseMetadata(source []byte) (markdown []byte, metadata Metadata)
• type Post
• type Posts
  • func (p Posts) Len() int
  • func (p Posts) Less(i, j int) bool
  • func (p Posts) Swap(i, j int)

Functions

func Sort

func Sort(sortable interface{}) interface{}

func SortRev

func SortRev(sortable interface{}) interface{}

Types

type Metadata

type Metadata struct {
	Title      string    `yaml:"title" toml:"title" json:"title" org:"title"`
	IsDraft    bool      `yaml:"draft" toml:"draft" json:"draft" org:"draft"`
	Layout     string    `yaml:"layout" toml:"layout" json:"layout" org:"layout"`
	Date       time.Time `yaml:"date" toml:"date" json:"date" org:"date"`
	Summary    string    `yaml:"summary" toml:"summary" json:"summary" org:"summary"`
	IsHeadless bool      `yaml:"headless" toml:"headless" json:"headless" org:"headless"`
}

Metadata contains all recognized Hugo properties.

func ParseMetadata

func ParseMetadata(source []byte) (markdown []byte, metadata Metadata)

ParseMetadata extracts TOML/JSON/YAML/org-mode format front matter from Markdown text. If no metadata is found, markdown will be equal to source.

TOML front matter is identified as +++ symbols at the very start of the text, followed by TOML content, followed by another +++ (YAML is the same, but with ---). JSON front matter is identified as a JSON object followed by two newline symbols. org-mode front matter is identified as a set of #+KEY: VALUE lines, the first line started with anything else but #+ ends the front matter.

type Post

type Post struct {
	Post     []byte
	Metadata Metadata
	Link     string
}

type Posts

type Posts []Post

Posts implements sort.Interface.

func (Posts) Len

func (p Posts) Len() int

func (Posts) Less

func (p Posts) Less(i, j int) bool

func (Posts) Swap

func (p Posts) Swap(i, j int)