build

Documentation

Index

• func Build(ctx context.Context, dir, out string, flags Flags) error
• type Flags

Functions

func Build

func Build(ctx context.Context, dir, out string, flags Flags) error

Build builds the site rooted at dir into the directory named by out. If out is empty, the site is built into outSubdir under the site directory.

Types

type Flags

type Flags int

Flags specifies details of how the site should be built.

const (
	// PrettyPrint indicates that HTML output should be pretty-printed.
	PrettyPrint Flags = 1 << iota
	// Display a diff of changes and prompt before replacing the existing output dir.
	// Only has an effect when Build's out argument is empty.
	Prompt
	// Serve indicates that the new output dir should be served over HTTP while the diff is displayed.
	// Only has an effect when Prompt is true and Build's out argument is empty.
	Serve
	// Validate indicates that HTML and CSS output should be validated.
	Validate
)