HtmlAddressingStrategy.PinnedIndexTopics Property

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Gets the collection of pinned index topics, which are assigned specific paths relative to the documentation root.

public IReadOnlyDictionary<string, string> PinnedIndexTopics { get; }

Property Value

IReadOnlyDictionary<string, string>: A collection of topics that should be considered as index topics and placed at a specific path. The key of the dictionary is the topic name, and the value is the relative path where the topic should be located.

Remarks

When a topic is pinned, it is given a specific path that overrides the default addressing scheme. If a pinned topic has subtopics, they will also be addressed relative to the pinned topic's path.