Skip to main content

​
Definition

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

​
Syntax

Mintlify.Core.Models.BannerConfig

​
Summary

Represents the banner configuration for displaying announcements or notifications in the Mintlify documentation site.

​
Remarks

This configuration allows you to display a banner at the top of your documentation for important announcements, updates, or notifications. The banner supports MDX formatting.

​
Constructors

​
.ctor

​
Syntax

public BannerConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Content

Gets or sets the content to display in the banner.

​
Syntax

public string Content { get; set; }

​
Property Value

Type: string?

​
Remarks

The text or MDX content that will be displayed in the banner. MDX formatting is supported, allowing for rich content including links, emphasis, and other formatting. This content should be concise but informative.

​
Dismissible

Gets or sets whether to show a dismiss button on the banner.

​
Syntax

public System.Nullable<bool> Dismissible { get; set; }

​
Property Value

Type: System.Nullable<bool>?

​
Remarks

When true, displays a dismiss button (X) on the right side of the banner, allowing users to close the banner. When false or not specified, the banner cannot be dismissed by users and will always be visible.

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