StructureStructureHTMLPage
HTMLPageBuilder
Builds complete HTML pages from render nodes.
struct HTMLPageBuilderOverview
This type constructs the full HTML document structure including the <head> and <body> elements, navigation, and content.
Topics
let configuration: Configuration configurationThe configuration for page building.
let linkResolver : PageLinkResolver linkDecides where links to other documentation pages point.
let navigationIndex : NavigationIndex ? navigationThe navigation index for building the sidebar.
let sidebarDocument : SidebarDocument ? sidebarThe shared sidebar document embedded by documentation pages.
func buildPage (from: RenderNode , references: [String : any RenderReference ]) throws -> String buildBuilds a complete HTML page from a render node.
static let breadcrumbCollapseLimit : Int breadcrumbThe number of parents from which the breadcrumbs always collapse the farthest ones.
static var chromeToggles : String chromeThe checkboxes that hold the open or closed state of the page chrome.
static let declarationBreakClass : String declarationThe class of the line breaks and indentation that formatting adds to a declaration.
static let declarationParenthesisBreakClass : String declarationThe additional class of a declaration line break after an opening or before a closing parenthesis, which a single-line declaration leaves out entirely.
static let eyebrowKindClass : String eyebrowThe class of the hidden name of a page’s kind after its eyebrow.
static let heroAbstractClass : String heroThe class of the element that wraps a page’s abstract in the hero.
static let navigationMenuToggleIdentifier : String navigationThe identifier of the checkbox that opens the navigation bar menu on narrow viewports.
static let navigationTitleIconClass : String navigationThe class of the empty element before the text of the navigation bar title.
static let onThisPageContainerClass : String onThe class of the sticky “On This Page” navigator column.
static let sidebarToggleIdentifier : String sidebarThe identifier of the checkbox that shows or hides the documentation navigator.
static let topicKindBadgeClass : String topicThe class of the hidden element in every topic that names the topic’s kind.
static let topicTitleClass : String topicThe class of the hidden plain title of a topic that shows its declaration.
Relationships
Swift.Sendable Swift.Sendable Metatype
See Also
struct RenderContentHTMLRenderer RenderRenders DocC render content to HTML.
struct IndexPageBuilder IndexBuilds a combined index page listing all documented modules.
class StaticHTMLConsumer StaticA consumer that writes documentation to static HTML files.