MarkdownRenderer - DotNetDocs

Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.Renderers Inheritance: CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Syntax

CloudNimble.DotNetDocs.Core.Renderers.MarkdownRenderer

Summary

Renders documentation as Markdown files.

Remarks

Generates structured Markdown documentation with support for customizations including insertions, overrides, exclusions, transformations, and conditions.

Constructors

.ctor

Initializes a new instance of the MarkdownRenderer class.

Syntax

public MarkdownRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null)

Parameters

Name	Type	Description
`context`	`CloudNimble.DotNetDocs.Core.ProjectContext?`	The project context. If null, a default context is created.

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Initializes a new instance of the MarkdownRendererBase class.

Syntax

public MarkdownRendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null)

Parameters

Name	Type	Description
`context`	`CloudNimble.DotNetDocs.Core.ProjectContext?`	The project context. If null, a default context is created.

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Initializes a new instance of the RendererBase class.

Syntax

protected RendererBase(CloudNimble.DotNetDocs.Core.ProjectContext context = null, bool enabled = true)

Parameters

Name	Type	Description
`context`	`CloudNimble.DotNetDocs.Core.ProjectContext?`	The project context. If null, a default context is created.
`enabled`	`bool`	-

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Context Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the project context for this renderer.

Syntax

protected CloudNimble.DotNetDocs.Core.ProjectContext Context { get; }

Property Value

Type: CloudNimble.DotNetDocs.Core.ProjectContext The project context containing configuration and settings.

Enabled Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

When more than one Renderer is registered, allows a renderer to be turned off.

Syntax

public bool Enabled { get; set; }

Property Value

Type: bool

FileNamingOptions Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the file naming options for this renderer.

Syntax

protected CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions FileNamingOptions { get; }

Property Value

Type: CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions The file naming configuration.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

EscapeXmlTagsInString Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Escapes XML/HTML tag syntax for safe rendering in Markdown/MDX.

Syntax

protected static string EscapeXmlTagsInString(string stringToEscape)

Parameters

Name	Type	Description
`stringToEscape`	`string?`	The string potentially containing XML/HTML tag syntax or generic type brackets.

Returns

Type: string The escaped string safe for MDX rendering.

Remarks

Converts angle brackets to HTML entities to prevent MDX parser interpretation as JSX/HTML tags. This handles both generic type syntax (e.g., JsonConverter<object>) and XML documentation tags (e.g., <see cref=”…”>) by converting them to JsonConverter<object> and <see cref=”…”> respectively.

GetAccessModifier Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the access modifier string for the given accessibility.

Syntax

protected string GetAccessModifier(Microsoft.CodeAnalysis.Accessibility accessibility)

Parameters

Name	Type	Description
`accessibility`	`Microsoft.CodeAnalysis.Accessibility`	The accessibility to convert.

Returns

Type: string The access modifier string.

GetBestPracticesTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for best practices documentation.

Syntax

protected static string GetBestPracticesTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (type, assembly, etc.).

Returns

Type: string A markdown template string for best practices documentation.

GetConsiderationsTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for considerations documentation.

Syntax

protected static string GetConsiderationsTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (type, assembly, etc.).

Returns

Type: string A markdown template string for considerations documentation.

GetEventSignature Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the event signature string.

Syntax

protected string GetEventSignature(Microsoft.CodeAnalysis.IEventSymbol evt)

Parameters

Name	Type	Description
`evt`	`Microsoft.CodeAnalysis.IEventSymbol`	The event symbol.

Returns

Type: string The event signature.

GetExamplesTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for examples documentation.

Syntax

protected static string GetExamplesTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (type, assembly, etc.).

Returns

Type: string A markdown template string for examples documentation.

GetFieldSignature Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the field signature string.

Syntax

protected string GetFieldSignature(Microsoft.CodeAnalysis.IFieldSymbol field)

Parameters

Name	Type	Description
`field`	`Microsoft.CodeAnalysis.IFieldSymbol`	The field symbol.

Returns

Type: string The field signature.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetHeaderText Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets the header text to use for a content section, or null if no header should be added. Returns null if the content already contains the specified header.

Syntax

protected static string GetHeaderText(string content, string headerText)

Parameters

Name	Type	Description
`content`	`string?`	The content to check.
`headerText`	`string`	The header text that would be added (e.g., ”## Summary”).

Returns

Type: string? The header text to add, or null if no header should be added.

GetMemberSignature Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the member signature for a member symbol.

Syntax

protected string GetMemberSignature(CloudNimble.DotNetDocs.Core.DocMember member)

Parameters

Name	Type	Description
`member`	`CloudNimble.DotNetDocs.Core.DocMember`	The member to get the signature for.

Returns

Type: string The member signature string.

GetMethodSignature Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the method signature string.

Syntax

protected string GetMethodSignature(Microsoft.CodeAnalysis.IMethodSymbol method)

Parameters

Name	Type	Description
`method`	`Microsoft.CodeAnalysis.IMethodSymbol`	The method symbol.

Returns

Type: string The method signature.

GetNamespaceFileName Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets a safe file name for a namespace, suitable for use in file systems.

Syntax

public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension)

Parameters

Name	Type	Description
`ns`	`CloudNimble.DotNetDocs.Core.DocNamespace`	The namespace to get the file name for.
`extension`	`string`	The file extension (without the dot).

Returns

Type: string A safe file name for the namespace.

Remarks

This method is deprecated. Use GetNamespaceFilePath instead.

GetNamespaceFilePath Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the file path for a namespace documentation file.

Syntax

protected string GetNamespaceFilePath(CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension)

Parameters

Name	Type	Description
`ns`	`CloudNimble.DotNetDocs.Core.DocNamespace`	The namespace to get the file path for.
`outputPath`	`string`	The base output path.
`extension`	`string`	The file extension (without the dot).

Returns

Type: string The full file path for the namespace documentation.

GetPatternsTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for patterns documentation.

Syntax

protected static string GetPatternsTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (type, assembly, etc.).

Returns

Type: string A markdown template string for patterns documentation.

GetPropertySignature Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the property signature string.

Syntax

protected string GetPropertySignature(Microsoft.CodeAnalysis.IPropertySymbol property)

Parameters

Name	Type	Description
`property`	`Microsoft.CodeAnalysis.IPropertySymbol`	The property symbol.

Returns

Type: string The property signature.

GetRelatedApisTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for related APIs documentation.

Syntax

protected static string GetRelatedApisTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (type, assembly, etc.).

Returns

Type: string A markdown template string for related APIs documentation.

GetSafeNamespaceName Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets a safe namespace name for use in file names and display.

Syntax

public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns)

Parameters

Name	Type	Description
`ns`	`CloudNimble.DotNetDocs.Core.DocNamespace`	The namespace to get the name for.

Returns

Type: string A safe namespace name, using “global” for the global namespace.

GetSafeTypeName Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets a safe type name for use in file names, removing invalid characters.

Syntax

protected string GetSafeTypeName(CloudNimble.DotNetDocs.Core.DocType type)

Parameters

Name	Type	Description
`type`	`CloudNimble.DotNetDocs.Core.DocType`	The type to get the name for.

Returns

Type: string A safe type name with invalid characters replaced.

GetSummaryTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for summary documentation.

Syntax

protected static string GetSummaryTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (namespace, assembly, etc.).

Returns

Type: string A markdown template string for summary documentation.

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

GetTypeFileName Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets a safe file name for a type, suitable for use in file systems.

Syntax

public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension)

Parameters

Name	Type	Description
`type`	`CloudNimble.DotNetDocs.Core.DocType`	The type to get the file name for.
`ns`	`CloudNimble.DotNetDocs.Core.DocNamespace`	The namespace containing the type.
`extension`	`string`	The file extension (without the dot).

Returns

Type: string A safe file name for the type.

Remarks

This method is deprecated. Use GetTypeFilePath instead.

GetTypeFilePath Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the file path for a type documentation file.

Syntax

protected string GetTypeFilePath(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string outputPath, string extension)

Parameters

Name	Type	Description
`type`	`CloudNimble.DotNetDocs.Core.DocType`	The type to get the file path for.
`ns`	`CloudNimble.DotNetDocs.Core.DocNamespace`	The namespace containing the type.
`outputPath`	`string`	The base output path.
`extension`	`string`	The file extension (without the dot).

Returns

Type: string The full file path for the type documentation.

GetTypeSignature Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Gets the type signature string.

Syntax

protected string GetTypeSignature(CloudNimble.DotNetDocs.Core.DocType type)

Parameters

Name	Type	Description
`type`	`CloudNimble.DotNetDocs.Core.DocType`	The type to get the signature for.

Returns

Type: string The type signature.

GetUsageTemplate Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

Gets a template for usage documentation.

Syntax

protected static string GetUsageTemplate(string entityName)

Parameters

Name	Type	Description
`entityName`	`string`	The name of the entity (type, assembly, etc.).

Returns

Type: string A markdown template string for usage documentation.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

RemoveIndentation Inherited

Inherited from CloudNimble.DotNetDocs.Core.Renderers.RendererBase

Removes common leading indentation from multi-line text content.

Syntax

internal static string RemoveIndentation(string text)

Parameters

Name	Type	Description
`text`	`string`	The text to remove indentation from.

Returns

Type: string The text with common indentation removed.

RenderAsync

Renders the documentation assembly to Markdown files.

Syntax

public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model)

Parameters

Name	Type	Description
`model`	`CloudNimble.DotNetDocs.Core.DocAssembly?`	The documentation assembly to render, or null for documentation-only mode.

Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous rendering operation.

RenderPlaceholdersAsync

Renders placeholder conceptual content files for the documentation assembly.

Syntax

public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model)

Parameters

Name	Type	Description
`model`	`CloudNimble.DotNetDocs.Core.DocAssembly`	The documentation assembly to generate placeholders for.

Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous placeholder rendering operation.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

CloudNimble.DotNetDocs.Core.IDocRenderer

⌘I

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ Context Inherited

​Syntax

​Property Value

​ Enabled Inherited

​Syntax

​Property Value

​ FileNamingOptions Inherited

​Syntax

​Property Value

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ EscapeXmlTagsInString Inherited

​Syntax

​Parameters

​Returns

​Remarks

​ GetAccessModifier Inherited

​Syntax

​Parameters

​Returns

​ GetBestPracticesTemplate Inherited

​Syntax

​Parameters

​Returns

​ GetConsiderationsTemplate Inherited

​Syntax

​Parameters

​Returns

​ GetEventSignature Inherited

​Syntax

​Parameters

​Returns

​ GetExamplesTemplate Inherited

​Syntax

​Parameters

​Returns

​ GetFieldSignature Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetHeaderText Inherited

​Syntax

​Parameters

​Returns

​ GetMemberSignature Inherited

​Syntax

​Parameters

​Returns

​ GetMethodSignature Inherited

​Syntax

​Parameters

​Returns

​ GetNamespaceFileName Inherited

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Parameters

.ctor Inherited

Syntax

Parameters

.ctor Inherited

Syntax

Properties

Context Inherited

Syntax

Property Value

Enabled Inherited

Syntax

Property Value

FileNamingOptions Inherited

Syntax

Property Value

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

EscapeXmlTagsInString Inherited

Syntax

Parameters

Returns

Remarks

GetAccessModifier Inherited

Syntax

Parameters

Returns

GetBestPracticesTemplate Inherited

Syntax

Parameters

Returns

GetConsiderationsTemplate Inherited

Syntax

Parameters

Returns

GetEventSignature Inherited

Syntax

Parameters

Returns

GetExamplesTemplate Inherited

Syntax

Parameters

Returns

GetFieldSignature Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetHeaderText Inherited

Syntax

Parameters

Returns

GetMemberSignature Inherited

Syntax

Parameters

Returns

GetMethodSignature Inherited

Syntax

Parameters

Returns

GetNamespaceFileName Inherited