Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: Mintlify.Core.Models.ThemePairConfig

Syntax

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

.ctor Inherited

Inherited from Mintlify.Core.Models.ThemePairConfig

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Dark Inherited Virtual

Inherited from Mintlify.Core.Models.ThemePairConfig
Gets or sets the value for dark mode.

Syntax

Property Value

Type: string?

Light Inherited Virtual

Inherited from Mintlify.Core.Models.ThemePairConfig
Gets or sets the value for light mode.

Syntax

Property Value

Type: string?

Url

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

Syntax

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

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Override

Returns the string representation of the background image configuration.

Syntax

Returns

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

ToString Override

Inherited from Mintlify.Core.Models.ThemePairConfig
Returns the string representation of the theme pair configuration.

Syntax

Returns

Type: string The light value, dark value, or empty string.

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?