Skip to main content

Definition

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

Syntax

CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions

Summary

Configuration options for the Mintlify documentation renderer.

Constructors

.ctor

Syntax

public MintlifyRendererOptions()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

GenerateDocsJson

Gets or sets whether to generate the docs.json navigation file.

Syntax

public bool GenerateDocsJson { get; set; }

Property Value

Type: bool True to generate docs.json alongside MDX files; otherwise, false. Default is true.

GenerateNamespaceIndex

Gets or sets whether to generate index files for namespaces.

Syntax

public bool GenerateNamespaceIndex { get; set; }

Property Value

Type: bool True to generate index.mdx files for namespace documentation; otherwise, false. Default is true.

IncludeIcons

Gets or sets whether to include icons in navigation and frontmatter.

Syntax

public bool IncludeIcons { get; set; }

Property Value

Type: bool True to include FontAwesome icons; otherwise, false. Default is true.

NamespaceOrder

Gets or sets the custom order for namespaces in navigation.

Syntax

public System.Collections.Generic.List<string> NamespaceOrder { get; set; }

Property Value

Type: System.Collections.Generic.List<string>? A list of namespace patterns in the desired order, or null for alphabetical ordering. Supports wildcards (e.g., “System.*” matches all System namespaces). Gets or sets the navigation configuration for DotNetDocs-specific properties.

Syntax

public CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig Navigation { get; set; }

Property Value

Type: CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig A DocsNavigationConfig instance that controls navigation mode, type, and name. Default is a new instance with Mode=Unified, Type=Pages, and Name=null.

Template

Gets or sets a custom template for the docs.json configuration.

Syntax

public Mintlify.Core.Models.DocsJsonConfig Template { get; set; }

Property Value

Type: Mintlify.Core.Models.DocsJsonConfig? A DocsJsonConfig instance to use as a template, or null to use defaults. The navigation section will be generated automatically.

UnifiedGroupName

Gets or sets the group name used when NavigationMode is Unified.

Syntax

public string UnifiedGroupName { get; set; }

Property Value

Type: string The name of the unified API reference group. Default is “API Reference”.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

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

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?