Documentation Language: Swift

Structure

HTMLPageBuilder

Builds complete HTML pages from render nodes.

struct HTMLPageBuilder

Overview

This type constructs the full HTML document structure including the <head> and <body> elements, navigation, and content.

Topics

Initializers

?
init(configuration:navigationIndex:)

Creates a new page builder.

Instance Properties

V
configuration

The configuration for page building.

V
navigationIndex

The navigation index for building the sidebar.

Instance Methods

F
buildPage(from:references:)

Builds a complete HTML page from a render node.

F
buildTutorialOverviewPage(from:references:)

Builds a complete HTML page for tutorials with specialized navigation and layout.

F
buildTutorialPage(from:references:)

Tutorials use a different layout from regular documentation:

Relationships

Conforms To

See Also

Rendering

S
RenderContentHTMLRenderer

Renders DocC render content to HTML.

S
IndexPageBuilder

Builds a combined index page listing all documented modules.

C
StaticHTMLConsumer

A consumer that writes documentation to static HTML files.