docs

type Config struct {
	// Root is the repo root, it defaults to the working directory.
	Root string
	// OutDir holds the generated markdown, relative to Root.
	OutDir string
	// HTMLDir holds the generated html, empty skips the site step.
	HTMLDir string
	// Check reports stale files instead of writing them.
	Check bool
}

type Pipeline struct {
	// contains filtered or unexported fields
}

type Result struct {
	// Written lists the paths written to disk, empty in check mode.
	Written []string
	// Stale lists the paths that differ from the tree, only filled in check mode.
	Stale []string
	// Diff is a readable diff of the stale files, only filled in check mode.
	Diff string
}

type Step struct {
	// Name is used in log and error messages.
	Name string
	// HTMLOnly marks a step that only runs when HTMLDir is set.
	HTMLOnly bool
	// Run fills the pipeline with the files the step produces.
	Run func(p *Pipeline) error
}