Module

PuduLangDocgen.Site.View

View source

Everything a layout shows for one page, as template metadata

Types

Name Description
Frame Navigation and history around a page

Functions

Name Description
view The view of a page: site identity, navigation, content, and interface text. Page metadata switches parts off with `_disableToc`, `_disableAffix`, `_disableBreadcrumb`, `_disableNavbar`, `_disableContribution`, `_disableNextArticle`, and `_enableSearch: false`.
tocHtml Nested navigation as HTML lists; items on the trail to the page start expanded.

view

fn view(page: &Docgen.Page, frame: &Frame) -> Docgen.Meta

The view of a page: site identity, navigation, content, and interface text. Page metadata switches parts off with _disableToc, _disableAffix, _disableBreadcrumb, _disableNavbar, _disableContribution, _disableNextArticle, and _enableSearch: false.

Parameters

page
&Docgen.Page
frame
&Frame

Returns

Docgen.Meta

View source

tocHtml

fn tocHtml(items: &Array[Docgen.TocItem], page: Str, trail: &Array[Docgen.TocItem]) -> Str

Nested navigation as HTML lists; items on the trail to the page start expanded.

Parameters

items
&Array[Docgen.TocItem]
page
Str
trail
&Array[Docgen.TocItem]

Returns

Str

View source