Skip to main content

Module html

Module html 

Source
Expand description

Full HTML document assembly: wraps rendered page bodies in the site shell (head, nav, breadcrumbs, footer, interactivity script) and produces the static CSS/favicon assets.

Appearance is a caller-supplied input (SiteStyle) with built-in defaults. A publishing client can pass a color theme, fully-custom CSS, or a custom favicon; when it passes nothing, the server-side default styling (the bundled stylesheet, no favicon) is used. The same renderer runs client-side (publish plugin) and server-side (ARK Layer 3 render-on-write).

The document around the body is caller-supplied on the same terms: a ShellTemplate replaces the built-in shell below, filling the same ShellSlots it does. Both shells are assembled from one set of slots precisely so a template cannot see a different page than the default does.

Structs§

Generator
The tool that built the site, credited in the footer of every shell that carries one.
HtmlRenderer
Assembles complete HTML documents from rendered page bodies.
PageContext
Everything about the site that wrapping one page in its shell needs.
SiteStyle
Caller-supplied appearance for the rendered site.

Constants§

ISLAND_CHILD_SCRIPT
The child half of the island resize protocol, for an embedded HTML document to load with <script src="…/diaryx-island.js"></script>.
ISLAND_CHILD_SCRIPT_FILENAME
The well-known filename HtmlRenderer::static_assets writes ISLAND_CHILD_SCRIPT to.