internal

Documentation

Index

• func Generate(srcFolder, destination string, s *site) error
• func NewDocument(path string, content []byte) (document, error)
• func NewSite(folder string) (*site, error)
• type Link

Functions

func Generate

func Generate(srcFolder, destination string, s *site) error

Generates the static html files for the site and writes them to the destination folder.

func NewDocument

func NewDocument(path string, content []byte) (document, error)

NewDocument takes the path of a document and its content and returns a parsed document with the metadata applied.

func NewSite

func NewSite(folder string) (*site, error)

Reads the folder and returns the parsed site with all the documents this site will be used to generate the static html files.

Types

type Link

type Link struct {
	Text     string
	Link     string
	Icon     string
	ImageSrc string
}