lib

package

v0.0.0-...-0748796 Latest Latest Go to latest Published: Nov 17, 2022 License: Apache-2.0 Imports: 15 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 CompileTemplate(name string, raw []byte) ([]byte, error)

CompileTemplate compiles an HTML template

func Contains(slice []string, str string) bool

Contains checks if a slice contains a string

func Handle(err error)

Handle handles errors

func HasExt(str, ext string) bool

HasExt gets and validates a string's file extension

func MinifyHTML(content []byte) ([]byte, error)

MinifyHTML runs tdedwolff/minify on a byte array consisting of HTML content

func MoveAssets(baseDir, outputDir string) (err error)

MoveAssets loads all asset files from directory and moves them into the `outputDir`.

type Document struct {
	FileInfo os.FileInfo
	Content  []byte
	Layout   []byte
	FullPath string
}

Document is a Scarecrow document file

func (d *Document) Compile(dir, output string) (err error)

Compile turns a markdown document into a fully-formed HTML file using a layout