DocumentUrlContext.DocumentationRootUrl Property

Namespace
Kampute.DocToolkit.Routing
Assembly
  • Kampute.DocToolkit.dll

Definition

Gets the absolute or document-relative URL to the documentation root for the current context.
public abstract Uri DocumentationRootUrl { get; }

Property Value

Uri
The URL that identifies the documentation root from the current document.

Remarks

The documentation root may differ from the web site's root, such as when documentation is published below a repository path. A relative value describes navigation from the current document to the documentation root; an absolute value identifies the published documentation root directly.

When the root URL is a relative URL, it represents the path from the current document to the root of the documentation site. The following examples illustrate how a relative root URL is computed based on document location:

  • For a document at the root level: ""
  • For a document in a first-level directory: "../"
  • For a document in a second-level directory: "../../"