Skip to main content

Module types

Module types 

Source
Expand description

Pure value types describing a site to be rendered.

Nothing here opens, resolves or allocates anything on disk. These are the description a caller hands the renderer, which is why the same description can be assembled by a CLI, by a server, or by an edge worker.

Appearance types (colors, typography, favicon, theme) live in crate::appearance.

Structs§

FrameDoc
A document that frames every page — a site’s header or footer — as the text of the file and the path it was read from.
Grouping
What a grouped arrangement sorts entries into groups by.
Heading
One heading of a rendered body, as the outline lists it.
LinkEdge
One link between two documents, named by the relation that carries it.
NavLink
A navigation link.
OutlineNode
One node of a site’s spanning outline: the archive’s own containment hierarchy, materialized by whoever holds the workspace.
PublishOptions
Options for publishing.
PublishResult
Result of a publishing operation.
PublishedPage
A processed file ready for publishing.
SiteNavNode
A node in the full site navigation tree.
SiteNavigation
Full site navigation context for a specific page.

Enums§

Arrangement
How a site is arranged — the render-side half of a site’s view:.
Grain
What a grouped arrangement sorts entries into groups by.
PageLayout
Which shell a page is wrapped in, from its frontmatter layout:.

Functions§

output_filename
Convert a canonical source path to its sanitized .html output filename.
serve_at_dest
Normalize a frontmatter serve_at: value into a path below the site root, or None when it claims nothing this crate can serve.