​
Definition

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

​
Syntax

Mintlify.Core.Models.BackgroundImageConfig

​
Summary

Represents a background image configuration in Mintlify.

​
Remarks

Background images can be simple URL/path references or theme-specific configurations with separate images for light and dark modes. This matches the official Mintlify schema.

​
Constructors

​
.ctor

​
Syntax

public BackgroundImageConfig()

​
Properties

​
Dark

Gets or sets the background image for dark mode.

​
Syntax

public string Dark { get; set; }

​
Property Value

Type: string?

​
Remarks

Can be an absolute URL or relative path to an image file. Used when the theme switches to dark mode.

​
Light

Gets or sets the background image for light mode.

​
Syntax

public string Light { get; set; }

​
Property Value

Type: string?

​
Remarks

Can be an absolute URL or relative path to an image file. Used when the theme is in light mode.

​
Url

Gets or sets the single image URL when not using theme-specific images.

​
Syntax

public string Url { get; set; }

​
Property Value

Type: string?

​
Remarks

Used internally when the background image is a simple string. Not serialized directly as it’s handled by the converter.

​
Methods

​
ToString

Returns the string representation of the background image configuration.

​
Syntax

public override string ToString()

​
Returns

Type: string The URL, light image, dark image, or empty string.