MintlifyMarkdownTransformer

Definition

Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Mintlify.Transformers Inheritance: System.Object

Syntax

CloudNimble.DotNetDocs.Mintlify.Transformers.MintlifyMarkdownTransformer

Summary

Transforms HTML-style comments to JSX-style comments for MDX compatibility.

Remarks

MDX (used by Mintlify) requires JSX-style comments instead of HTML comments <!— —>. This transformer processes all string properties in the DocEntity object graph and converts HTML comments to JSX comments to prevent MDX parsing errors.

Constructors

.ctor

Syntax

public MintlifyMarkdownTransformer()

.ctor Inherited

Inherited from object

Syntax

public Object()

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

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

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

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

TransformAsync

Transforms a documentation entity by converting HTML comments to JSX comments.

Syntax

public System.Threading.Tasks.Task TransformAsync(CloudNimble.DotNetDocs.Core.DocEntity entity)

Parameters

Name	Type	Description
`entity`	`CloudNimble.DotNetDocs.Core.DocEntity`	The documentation entity to transform.

Returns

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

CloudNimble.DotNetDocs.Core.IDocTransformer

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​ TransformAsync

​Syntax

​Parameters

​Returns

​Related APIs

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

TransformAsync

Syntax

Parameters

Returns

Related APIs