Skip Navigation
Type MethodMethod

relativePageURL(_:depth:)

Returns a relative link to a generated page.

static func relativePageURL(
    _ path: String,
    depth: Int
) -> String

Parameters

path

The DocC path of the page, optionally followed by a fragment.

depth

The number of directories between the output root and the page that contains the link.

Return Value

The link to the page’s file, followed by the fragment if any.