Definition
Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Mintlify Inheritance: System.ObjectSyntax
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
.ctor Inherited
Inherited from
objectSyntax
Properties
Mode
Gets or sets the navigation mode for multi-assembly documentation.Syntax
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
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
Property Value
Type:CloudNimble.DotNetDocs.Mintlify.NavigationType?
The navigation type. Default is NavigationType.Pages.
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?