Skip Navigation
InitializerInitializer

init(configuration:navigationIndex:linkResolver:)

Creates a new page builder.

init(
    configuration: Configuration,
    navigationIndex: NavigationIndex? = nil,
    linkResolver: PageLinkResolver = .unrestricted
)

Parameters

configuration

The generation configuration.

navigationIndex

The navigation index for the sidebar (optional).

linkResolver

Decides where links to other pages point; by default every documentation page is assumed to be generated.

Discussion

Links to pages that linkResolver finds neither in the generated site nor in external documentation are shown as unlinked text, like swift-docc-render shows references it cannot resolve.