config

Documentation

Index

• type Config
  • func ForPath(ctx context.Context, s source.Source, path string) (*Config, error)

Types

type Config

type Config struct {
	// DefaultIndex is the filenames that should attempt to be rendered if no exact path is given
	DefaultIndex []string
	// Templates are the templates available to render markdown files, keyed by template name.
	Templates map[string]*template.Template

	// Errors that occured while building this config (due to config file errors, etc).
	Errors map[string]error
}

Config is a configuration concerning a given path of the source. It is built from files present in the source, and from global configuration.

func ForPath

func ForPath(ctx context.Context, s source.Source, path string) (*Config, error)