internal

package

v1.0.13 Latest Latest Go to latest Published: Jun 1, 2024 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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(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(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.

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