Documentation Index
Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
Use this file to discover all available pages before exploring further.
Definition
Assembly: Mintlify.Core.dll
Namespace: Mintlify.Core.Converters
Inheritance: System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.BackgroundImageConfig>
Syntax
Mintlify.Core.Converters.BackgroundImageConverter
Summary
Handles JSON conversion for background image properties that can be either strings or objects.
Background image configurations in Mintlify can be specified as:
Constructors
.ctor
Syntax
public BackgroundImageConverter()
Methods
CanConvert Override
Determines whether the specified type can be converted by this converter.
Syntax
public override bool CanConvert(System.Type typeToConvert)
Parameters
| Name | Type | Description |
|---|
typeToConvert | System.Type | The type to convert. |
Returns
Type: bool
True if the type is BackgroundImageConfig; otherwise, false.
Read Override
Reads and converts the JSON to a BackgroundImageConfig object.
Syntax
public override Mintlify.Core.Models.BackgroundImageConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options)
Parameters
| Name | Type | Description |
|---|
reader | System.Text.Json.Utf8JsonReader | The JSON reader. |
typeToConvert | System.Type | The type to convert to. |
options | System.Text.Json.JsonSerializerOptions | The serializer options. |
Returns
Type: Mintlify.Core.Models.BackgroundImageConfig?
A BackgroundImageConfig for both simple URLs and theme-specific configurations.
Exceptions
| Exception | Description |
|---|
JsonException | Thrown when the JSON token type is not supported. |
Write Override
Writes the BackgroundImageConfig object to JSON.
Syntax
public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.BackgroundImageConfig value, System.Text.Json.JsonSerializerOptions options)
Parameters
| Name | Type | Description |
|---|
writer | System.Text.Json.Utf8JsonWriter | The JSON writer. |
value | Mintlify.Core.Models.BackgroundImageConfig? | The BackgroundImageConfig value to write. |
options | System.Text.Json.JsonSerializerOptions | The serializer options. |
