DocsNavigationConfig

Definition

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

Syntax

CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig

Summary

Configuration for DotNetDocs-specific navigation properties.

Remarks

This class holds metadata that bridges .docsproj XML templates to Mintlify.Core, but is not part of the Mintlify docs.json specification itself. These properties control how DotNetDocs organizes and integrates documentation into the Mintlify navigation structure.

Constructors

.ctor

Syntax

public DocsNavigationConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Mode

Gets or sets the navigation mode for multi-assembly documentation.

Syntax

public CloudNimble.DotNetDocs.Mintlify.NavigationMode Mode { get; set; }

Property Value

Type: CloudNimble.DotNetDocs.Mintlify.NavigationMode? The navigation organization mode. Default is NavigationMode.Unified.

Name

Gets or sets the navigation name/title for this documentation project when Type is Tabs or Products.

Syntax

public string Name { get; set; }

Property Value

Type: string? The display name for the tab or product. If not specified, the project name will be used.

Type

Gets or sets the navigation type for this documentation project.

Syntax

public CloudNimble.DotNetDocs.Mintlify.NavigationType Type { get; set; }

Property Value

Type: CloudNimble.DotNetDocs.Mintlify.NavigationType? The navigation type. Default is NavigationType.Pages.

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?

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​Properties

​ Mode

​Syntax

​Property Value

​ Name

​Syntax

​Property Value

​ Type

​Syntax

​Property Value

​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

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

Properties

Mode

Syntax

Property Value

Name

Syntax

Property Value

Type

Syntax

Property Value

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