Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Descriptor ¶
type Descriptor struct {
// The content to publish.
Src io.Reader
// The OutputFormat of the this content.
OutputFormat output.Format
// Where to publish this content. This is a filesystem-relative path.
TargetPath string
// Counter for the end build summary.
StatCounter *uint64
// Configuration that trigger pre-processing.
// LiveReload script will be injected if this is > 0
LiveReloadPort int
// Enable to inject the Hugo generated tag in the header. Is currently only
// injected on the home page for HTML type of output formats.
AddHugoGeneratorTag bool
// If set, will replace all relative URLs with this one.
AbsURLPath string
// Enable to minify the output using the OutputFormat defined above to
// pick the correct minifier configuration.
Minify bool
}
Descriptor describes the needed publishing chain for an item.
type DestinationPublisher ¶
type DestinationPublisher struct {
// contains filtered or unexported fields
}
DestinationPublisher is the default and currently only publisher in Hugo. This publisher prepares and publishes an item to the defined destination, e.g. /public.
func NewDestinationPublisher ¶
func (DestinationPublisher) Publish ¶
func (p DestinationPublisher) Publish(d Descriptor) error
Publish applies any relevant transformations and writes the file to its destination, e.g. /public.
type Publisher ¶
type Publisher interface {
Publish(d Descriptor) error
}
Publisher publishes a result file.
Click to show internal directories.
Click to hide internal directories.