Skip Navigation
InitializerInitializer

init(navigationIndex:deprecatedPagePaths:)

Creates a new navigation sidebar builder.

init(
    navigationIndex: NavigationIndex,
    deprecatedPagePaths: Set<String> = []
)

Parameters

navigationIndex

The navigation index to build from.

deprecatedPagePaths

The paths of deprecated pages, normalised with pagePathKey(_:).

Discussion

Not every version of docc flags unconditionally deprecated symbols in the navigation index, so pages known to be deprecated can be named as well.