MarkdownAddressingOptions.MainTopicId Property

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Gets or sets the identifier of the topic that should serve as the main entry point for the documentation.

public string MainTopicId { get; set; }

Property Value

string: The identifier of the topic that should serve as the main entry point for the documentation.

Remarks

When this property is not empty, the topic with the specified identifier is used as the main topic of the documentation, and all other pages are placed under it. If the documentation context has no topic with this identifier, the addressing strategy throws an ArgumentException when it resolves page addresses.