Documentation Language: Swift

Method

buildIndexPage(modules:tutorials:indexContent:)

Builds the combined index page HTML.

func buildIndexPage(modules: [ModuleEntry], tutorials: [TutorialEntry] = [], indexContent: IndexContent? = nil) -> String

Parameters

modules

The documented modules to include.

tutorials

The tutorial collections to include.

indexContent

Optional content from an INDEX.md file. If provided, the title (if any) and body content are used. If nil, a default title and subtitle are shown instead.

Return Value

The complete HTML document as a string.