BannerConfig

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

Syntax

public class BannerConfig

Inheritance

Properties

Content

[JsonPropertyName("content")]
public string Content { get; set; }
Gets or sets the content to display in the banner.

Returns

string

Dismissible

[JsonPropertyName("dismissible")]
public bool? Dismissible { get; set; }
Gets or sets whether to show a dismiss button on the banner.

Returns

bool?

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.