Skip Navigation
Type MethodMethod

pagePathKey(of:)

Returns the normalised path of a page, from which its output location, its sidebar row and its search entry are derived.

static func pagePathKey(of reference: ResolvedTopicReference) -> String

Parameters

reference

The page’s topic reference, such as a render node’s identifier.

Return Value

The normalised path, such as documentation/module/type/'...(_:_:).

Discussion

The path is swift-docc’s file-safe path of the page, which the links of other pages and the navigation index also use, normalised with pagePathKey(_:).