MarkdownAddressingOptions Class

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

Definition

Provides options for Markdown-based addressing and organizing documentation pages.
public abstract class MarkdownAddressingOptions : AddressingOptions
Inheritance
Inherited by

Remarks

This abstract class defines common configuration options for Markdown addressing strategies that organize documentation pages as a hierarchy of pages named after their titles, such as the pages of a wiki. Derived classes should extend these options with additional configuration properties specific to particular Markdown publishing targets.

By default, the file extension is .md, it is included in the generated URLs, and C# is used for formatting member names.

Constructors

MarkdownAddressingOptions()Initializes a new instance of the MarkdownAddressingOptions class.
MarkdownAddressingOptions(string)Initializes a new instance of the MarkdownAddressingOptions class with a specified file extension.

Properties

ApiTopicIdGets or sets the identifier of the topic that should serve as the introduction or overview of the API references.
LanguageGets or sets the programming language formatter to be used for formatting member names.
MainTopicIdGets or sets the identifier of the topic that should serve as the main entry point for the documentation.

See Also