MarkdownDocReferenceHandler

Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Syntax

CloudNimble.DotNetDocs.Core.MarkdownDocReferenceHandler

Summary

Handler for Markdown-based documentation references providing content path rewriting.

Remarks

This class extends DocReferenceHandlerBase to add Markdown-specific content rewriting functionality. It handles standard Markdown image and link syntax, rewriting absolute paths to include the destination path prefix. Derived classes can extend this behavior to handle format-specific patterns such as JSX imports, component props, or other content-specific path references.

Constructors

.ctor

Syntax

public MarkdownDocReferenceHandler()

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Syntax

protected DocReferenceHandlerBase()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

DocumentationType Override

Syntax

public override CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; }

Property Value

Type: CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType

DocumentationType Inherited Abstract

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Syntax

public abstract CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; }

Property Value

Type: CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType

Methods

CopyDirectoryWithExclusionsAsync Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Recursively copies a directory and its contents, excluding files that match exclusion patterns.

Syntax

protected System.Threading.Tasks.Task CopyDirectoryWithExclusionsAsync(string sourceDir, string destDir, System.Collections.Generic.List<string> exclusionPatterns, bool skipExisting = true)

Parameters

Name	Type	Description
`sourceDir`	`string`	The source directory to copy from.
`destDir`	`string`	The destination directory to copy to.
`exclusionPatterns`	`System.Collections.Generic.List<string>`	List of glob patterns for files to exclude.
`skipExisting`	`bool`	Whether to skip files that already exist in the destination.

Returns

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

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

GetExclusionPatternsForDocumentationType Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Gets file exclusion patterns for a given documentation type when copying DocumentationReferences.

Syntax

protected System.Collections.Generic.List<string> GetExclusionPatternsForDocumentationType(CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType documentationType)

Parameters

Name	Type	Description
`documentationType`	`CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType`	The documentation type (Mintlify, DocFX, MkDocs, etc.).

Returns

Type: System.Collections.Generic.List<string> A list of glob patterns for files that should be excluded from copying.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MatchesGlobPattern Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Matches a file path against a glob pattern.

Syntax

protected bool MatchesGlobPattern(string path, string pattern)

Parameters

Name	Type	Description
`path`	`string`	The file path to match.
`pattern`	`string`	The glob pattern.

Returns

Type: bool True if the path matches the pattern, false otherwise.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ProcessAsync Override

Syntax

public override System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath)

Parameters

Name	Type	Description
`reference`	`CloudNimble.DotNetDocs.Core.DocumentationReference`	-
`documentationRootPath`	`string`	-

Returns

Type: System.Threading.Tasks.Task

ProcessAsync Inherited Abstract

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Syntax

public abstract System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath)

Parameters

Name	Type	Description
`reference`	`CloudNimble.DotNetDocs.Core.DocumentationReference`	-
`documentationRootPath`	`string`	-

Returns

Type: System.Threading.Tasks.Task

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

ShouldExcludeDirectory Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Determines if a directory should be excluded based on exclusion patterns.

Syntax

protected bool ShouldExcludeDirectory(string relativePath, System.Collections.Generic.List<string> exclusionPatterns)

Parameters

Name	Type	Description
`relativePath`	`string`	The relative path of the directory.
`exclusionPatterns`	`System.Collections.Generic.List<string>`	List of glob patterns for exclusion.

Returns

Type: bool True if the directory should be excluded, false otherwise.

ShouldExcludeFile Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Determines if a file should be excluded based on exclusion patterns.

Syntax

protected bool ShouldExcludeFile(string relativePath, System.Collections.Generic.List<string> exclusionPatterns)

Parameters

Name	Type	Description
`relativePath`	`string`	The relative path of the file.
`exclusionPatterns`	`System.Collections.Generic.List<string>`	List of glob patterns for exclusion.

Returns

Type: bool True if the file should be excluded, false otherwise.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

CloudNimble.DotNetDocs.Core.IDocReferenceHandler

Getting Started

Guides

Providers

Plugins

Learnings

API Reference

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​ .ctor Inherited

​Syntax

​Properties

​ DocumentationType Override

​Syntax

​Property Value

​ DocumentationType Inherited Abstract

​Syntax

​Property Value

​Methods

​ CopyDirectoryWithExclusionsAsync Inherited

​Syntax

​Parameters

​Returns

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetExclusionPatternsForDocumentationType Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MatchesGlobPattern Inherited

​Syntax

​Parameters

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ProcessAsync Override

​Syntax

​Parameters

​Returns

​ ProcessAsync Inherited Abstract

​Syntax

​Parameters

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ShouldExcludeDirectory Inherited

​Syntax

​Parameters

​Returns

​ ShouldExcludeFile Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​Related APIs

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

.ctor Inherited

Syntax

Properties

DocumentationType Override

Syntax

Property Value

DocumentationType Inherited Abstract

Syntax

Property Value

Methods

CopyDirectoryWithExclusionsAsync Inherited

Syntax

Parameters

Returns

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetExclusionPatternsForDocumentationType Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MatchesGlobPattern Inherited

Syntax

Parameters

Returns

MemberwiseClone Inherited

Syntax

Returns

ProcessAsync Override

Syntax

Parameters

Returns

ProcessAsync Inherited Abstract

Syntax

Parameters

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ShouldExcludeDirectory Inherited

Syntax

Parameters

Returns

ShouldExcludeFile Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

Related APIs