Skip to main content

Definition

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

Syntax

Mintlify.Core.Models.BackgroundConfig

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

public BackgroundConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Color

Gets or sets the background color configuration.

Syntax

public Mintlify.Core.Models.ColorConfig Color { get; set; }

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

public string Decoration { get; set; }

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

public Mintlify.Core.Models.BackgroundImageConfig Image { get; set; }

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