MarkdownAddressingStrategy Class

public abstract class MarkdownAddressingStrategy : AddressingStrategy, ILanguageSpecific, IContextualAddressingStrategy

This class defines the page structure shared by Markdown publishing targets such as wikis, where the name of a page is derived from its title and the pages nested under a page are placed in a folder with the same name:

• Each namespace has a page named after the namespace.
• Each type has a page named after the type, nested under the page of its namespace.
• Type members are documented on the page of their declaring type, and are addressed by the anchor of their heading.
• Each topic has a page named after its title, nested under the page of its parent topic.

When MarkdownAddressingOptions.MainTopicId is set, all other pages are nested under the page of the main topic. When MarkdownAddressingOptions.ApiTopicId is set, the namespace pages are nested under the page of the API topic.

Derived classes define how a title becomes a page name by implementing EncodePageName(string), and can override EncodeFragmentIdentifier(string) when the publishing target generates heading anchors differently from GitHub and GitLab. They can also override the methods that construct the page paths to change the page structure.

Important

A type member is addressed by the anchor of a heading whose text is the member signature formatted by Language with NameQualifier.None. Renderers must therefore write that heading for each member on the page of its declaring type, so that the generated links reach the member.

Public instance members can be considered thread-safe if neither MarkdownAddressingOptions.MainTopicId nor MarkdownAddressingOptions.ApiTopicId is set in the construction options of the instance. If either property is set, instance members are only thread-safe if the instance is fully initialized (that is, IContextualAddressingStrategy.InitializeWithContext(IDocumentationContext) has been called) before any other method is accessed, and there is no concurrent access during or before initialization.

The class is not thread-safe otherwise, because it contains a mutable context field and uses lazy initialization that depends on this field, without synchronization.