Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents the background configuration for the Mintlify documentation site.Remarks
This configuration controls the background appearance including images, decorations, and colors for the documentation site.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Color
Gets or sets the background color configuration.Syntax
Property Value
Type:Mintlify.Core.Models.ColorConfig?
Remarks
Can be a hex color string or an object with color configuration properties. This controls the base background color of the documentation site.Decoration
Gets or sets the background decoration style.Syntax
Property Value
Type:string?
Remarks
Valid values are “gradient”, “grid”, or “windows”. This adds decorative background patterns to enhance the visual appearance of the site.Image
Gets or sets the background image configuration.Syntax
Property Value
Type:Mintlify.Core.Models.BackgroundImageConfig?
Remarks
Can be a string URL for a single image, or an object with “light” and “dark” properties for different images in each mode. Should be an absolute URL or relative path to the image file.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?