document

type Config struct {
	// Author is the information for the website author.
	// This is used in metadata such as that of the RSS feed.
	Author feeds.Author `yaml:"author,omitempty"`
	// Debug is a flag that enables debug mode.
	Debug bool `yaml:"debug,omitempty"`
	// Development contains options specific to development.
	// They have no impact when building for production.
	Development struct {
		// URL is the base URL you will connect to while developing your website or Winter.
		// If blank, it defaults to "http://localhost:8100".
		URL string `yaml:"url,omitempty"`
	} `yaml:"development,omitempty"`
	// Description is the Description of the website.
	// This is used as metadata for the RSS feed.
	Description string `yaml:"description,omitempty"`
	// Dist is the location the site will be built into,
	// relative to the working directory.
	// After a build, this directory is suitable for deployment to the web as a set of static files.
	//
	// In other words, the path of any file in dist,
	// relative to dist,
	// is equivalent to the path component of the URL for that file.
	//
	// If blank, defaults to ./dist.
	Dist string `yaml:"dist,omitempty"`
	// Known helps the generated site follow the "Cool URIs don't change" rule
	// by remembering certain facts about what the site looks like,
	// and checking newly-generated sites against those facts.
	Known struct {
		// URIs holds the path to the known URIs file,
		// which Winter will generate, update, and maintain.
		//
		// You should commit this file.
		//
		// If unset, defaults to src/uris.txt.
		URIs string `yaml:"urls,omitempty"`
	} `yaml:"known,omitempty"`
	// Name is the name of the website.
	// This is used in various places in and out of templates.
	Name string `yaml:"name,omitempty"`
	// Gear is an array of Gear objects,
	// each describing a camera, lens, or other piece of gear
	// whose information can be extracted from EXIF data.
	//
	// Gear is used by Winter when processing photos to display photograph information,
	// and provide links to purchase gear used in its creation.
	Gear       []Gear `yaml:"gear,omitempty"`
	Production struct {
		// URL is the base URL you will connect to to view your deployed website
		// (e.g. twos.dev or one.twos.dev or twos.dev:6667).
		// This is used in various backlinks, like those in the RSS feed.
		//
		// Must not be blank.
		URL string `yaml:"url,omitempty"`
	} `yaml:"production,omitempty"`
	// Since is the year the website was established,
	// whether through Winter or otherwise.
	// This is used as metadata for the RSS feed,
	// and as a copyright notice when needed.
	Since int `yaml:"since,omitempty"`
	// Src is an additional list of directories to search for source files beyond ./src.
	Src []string `yaml:"srca,omitempty"`
}

type Document interface {
	// DependsOn returns true if and only if the given source path,
	// when changed,
	// should cause this document to be rebuilt.
	DependsOn(src string) bool
	// Load reads or re-reads the source file from disk,
	// overwriting any previously stored or parsed contents.
	Load(r io.Reader) error
	// Metadata returns data about the document,
	// which may have been inferred automatically or set by frontmatter.
	Metadata() *Metadata
	// Render generates the final HTML for the document and writes it to w.
	Render(w io.Writer) error
}

type EXIF struct {
	Aperture    float64
	Camera      *Gear
	FocalLength float64
	ISO         string
	// Lens holds information about the lens used for the photo.
	// If the photo EXIF data has no or insufficient lens information,
	// Lens is nil.
	Lens         *Gear
	ShutterSpeed string
	TakenAt      time.Time
}

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

type Gear struct {
	// Make is the user-readable brand that created this piece of gear.
	Make string `yaml:"make,omitempty"`
	// Model is the user-readable model for this piece of gear.
	Model string `yaml:"model,omitempty"`
	// Link is a URL
	// (beginning in https://)
	// at which a user can purchase or read more about this piece of gear.
	Link string `yaml:"link,omitempty"`
	// EXIF specifies what EXIF data a photograph must have in order to be identified as having been taken with this piece of gear.
	EXIF struct {
		// Make is the value a photograph's EXIF data must have in the "make" field,
		// whether camera or lens,
		// for the photograph to be considered as having been taken with this piece of gear.
		//
		// Before comparison,
		// Winter will strip all trailing and leading spaces from both the EXIF data field and from this field.
		// Then, a case-insensitive comparison is performed.
		Make string `yaml:"make,omitempty"`
		// Make is the value a photograph's EXIF data must have in the "model" field,
		// whether camera or lens,
		// for the photograph to be considered as having been taken with this piece of gear.
		//
		// Before comparison,
		// Winter will strip all trailing and leading spaces from both the EXIF data field and from this field.
		// Then, a case-insensitive comparison is performed.
		Model string `yaml:"model,omitempty"`
	} `yaml:"exif,omitempty"`
}

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

type GeminiRenderer interface {
	// RenderGemini converts the document into gemtext,
	// then writes the result to w.
	RenderGemini(w io.Writer) error
}

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

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

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

type Metadata struct {
	// Category is an optional category for the document. This is used
	// only for a small visual treatment on the index page (if this is
	// of kind post) and on the document page itself.
	//
	// Category MUST be a singular noun that can be pluralized by adding
	// a single "s" at its end, as this is exactly what the visual
	// treatment will do. If this doesn't work for you, go fix that
	// code.
	Category string `yaml:"category,omitempty"`
	// CreatedAt is the time the document was first published.
	CreatedAt time.Time `yaml:"date,omitempty"`
	// Kind specifies the type of document this is.
	// In every user-facing context, this is called "type".
	// In Go we cannot use the "type" keyword, so we use "kind" instead.
	Kind kind `yaml:"type,omitempty"`
	// Layout is the path to the source file for the layout this document should be rendered into.
	//
	// If unset, src/templates/text_document.html.tmpl is used.
	Layout string `yaml:"layout,omitempty"`
	// GeminiPath is the path component of the Geminispace URL that will point to this document,
	// once rendered.
	// GeminiPath MUST NOT contain any slashes;
	// everything is top-level.
	//
	// GeminiPath is equivalent to the path to the destination file relative to dist.
	GeminiPath string `yaml:"-,omitempty"`
	// ParentFilename is the filename component of another document that this one is a child of.
	// Parenthood is a purely semantic relationship for the benefit of the user.
	// Templates can access parents to influence rendering.
	ParentFilename string `yaml:"parent,omitempty"`
	// Preview is a sentence-long blurb of the document,
	// to be shown along with its title as a teaser of its contents.
	Preview string `yaml:"preview,omitempty"`
	// SourcePath is the location on disk of the original file that this document represents.
	// It is relative to the working directory.
	SourcePath string `yaml:"-"`
	// TemplateDir is the location on disk of a directory containing any templates that will be used in the document.
	// By default, it is src/templates.
	TemplateDir string `yaml:"-"`
	// Title is the human-readable title of the document.
	Title string `yaml:"title,omitempty"`
	// TOC is whether a table of contents should be rendered with the
	// document. If true, the table of contents is rendered immediately
	// above the first non-first-level heading.
	TOC bool `yaml:"toc,omitempty"`
	// UpdatedAt is the time the document was last meaningfully updated.
	UpdatedAt time.Time `yaml:"updated,omitempty"`
	// WebPath is the path component of the URL that will point to this document,
	// once rendered.
	// WebPath MUST NOT contain any slashes;
	// everything is top-level.
	//
	// WebPath is equivalent to the path to the destination file
	// relative to dist.
	WebPath string `yaml:"filename,omitempty"`
}

type OrgDocument struct {
	// SourcePath is the path on disk to the file this Org is read from or generated from.
	// The path is relative to the working directory.
	SourcePath string
	// contains filtered or unexported fields
}

type StaticDocument struct {
	SourcePath string
	// contains filtered or unexported fields
}

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

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

type TemplateNode struct {
	ast.Leaf
	Raw []byte
}