get

Documentation

Overview

Package get provides functionality for retrieving document metadata.

Index

• func Get(path string, opts ...Option) (report.Report, error)
• type Option
  • func Expr(e string) Option

Functions

func Get

func Get(path string, opts ...Option) (report.Report, error)

Get retrieves metadata from (markdown) files rooted at the given path.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is an option to Get.

func Expr

func Expr(e string) Option

Expr specifies an expression used to filter fields.