Skip Navigation
Instance MethodMethod

url(forPagePath:)

Returns the external URL of a documentation page.

func url(forPagePath path: String) -> String?

Parameters

path

The DocC path of the page, such as /documentation/fixturecolours/colour, without a fragment.

Return Value

The absolute URL of the page below the base URL of its module, ending in /, or nil if the path is not a documentation path or no base URL is configured for its module.