build

Documentation

Index

• Variables
• type Config
• type Worker
  • func NewWorker(rootDir string, cfg Config) (wk Worker, err error)
  • func (wk *Worker) Build(urlPath string, w io.Writer) ([]string, error)

Variables

var ErrDraftFile = errors.New("file is draft")

ErrDraftFile is error to notify that file is a draft.

Types

type Config

type Config struct {
	EnableCache  bool
	BuildDraft   bool
	MinifyOutput bool
}

Config is configuration for Worker.

type Worker

type Worker struct {
	RootDir    string
	ContentDir string
	// contains filtered or unexported fields
}

Worker is the one that build markdown into HTML file.

func NewWorker

func NewWorker(rootDir string, cfg Config) (wk Worker, err error)

NewWorker returns a new worker. Requires root dir which point to directory where site lives.

func (*Worker) Build

func (wk *Worker) Build(urlPath string, w io.Writer) ([]string, error)

Build builds HTML for specified URL path. There are two possible URL path combination : 1. It's pointed directly to content, e.g. /blog/awesome or /blog/awesome/1 2. It's URL for tag list, e.g. /blog/awesome/#cat or /blog/awesome/#cat/2