Skip to main content

Definition

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

Syntax

Mintlify.Core.Models.NavbarConfig

Summary

Represents the navigation bar configuration for the Mintlify documentation site.

Remarks

This configuration controls the content and appearance of the top navigation bar, including custom links and primary call-to-action buttons.

Constructors

.ctor

Syntax

public NavbarConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Gets or sets the list of navigation links to display in the navbar.

Syntax

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

Property Value

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

Remarks

Each link should have a label, optional icon, and href pointing to the destination. These links appear in the top navigation bar of the documentation site.

Primary

Gets or sets the primary call-to-action configuration in the navbar.

Syntax

public Mintlify.Core.Models.PrimaryNavigationConfig Primary { get; set; }

Property Value

Type: Mintlify.Core.Models.PrimaryNavigationConfig?

Remarks

Can be a button configuration with type “button”, label, and href properties, or a GitHub configuration with type “github” and href properties. This appears prominently in the navbar to drive user actions.

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?