Skip to main content

​
Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

​
Syntax

Mintlify.Core.Models.NavigationConfig

​
Summary

Represents the navigation configuration for Mintlify.

​
Remarks

This is a required field that defines the structure of your documentation. At minimum, you need to define some navigation items (pages, groups, tabs, etc.).

​
Constructors

​
.ctor

​
Syntax

public NavigationConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Anchors

Gets or sets the anchors in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.AnchorConfig> Anchors { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.AnchorConfig>? Gets or sets the dropdowns in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig> Dropdowns { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig>?

​
Global

Gets or sets global navigation items that appear on all sections and pages.

​
Syntax

public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; }

​
Property Value

Type: Mintlify.Core.Models.GlobalNavigationConfig?

​
Groups

Gets or sets the groups in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig> Groups { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig>?

​
Languages

Gets or sets the languages in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig> Languages { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig>?

​
Pages

Gets or sets the pages in the navigation.

​
Syntax

public System.Collections.Generic.List<object> Pages { get; set; }

​
Property Value

Type: System.Collections.Generic.List<object>?

​
Remarks

Pages can be either strings (page paths) or nested GroupConfig objects.

​
Products

Gets or sets the products in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.ProductConfig> Products { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.ProductConfig>?

​
Remarks

Products separate documentation into distinct product-specific sections.

​
Tabs

Gets or sets the tabs in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.TabConfig> Tabs { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.TabConfig>?

​
Versions

Gets or sets the versions in the navigation.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.VersionConfig> Versions { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.VersionConfig>?

​
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?