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.ColorConfig>
Syntax
Mintlify.Core.Converters.ColorConverter
Summary
Handles JSON conversion for color properties that can be either strings or objects.
Color configurations in Mintlify can be specified as:
- String: Simple hex color value (e.g., “#FF0000”)
- Object: Complex color configuration with light and dark mode properties
Constructors
.ctor
Syntax
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 ColorConfig; otherwise, false.
Read Override
Reads and converts the JSON to a ColorConfig object.
Syntax
public override Mintlify.Core.Models.ColorConfig 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.ColorConfig?
A ColorConfig object.
Exceptions
| Exception | Description |
|---|
JsonException | Thrown when the JSON token type is not supported. |
Write Override
Writes the ColorConfig object to JSON.
Syntax
public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.ColorConfig value, System.Text.Json.JsonSerializerOptions options)
Parameters
| Name | Type | Description |
|---|
writer | System.Text.Json.Utf8JsonWriter | The JSON writer. |
value | Mintlify.Core.Models.ColorConfig | The ColorConfig value to write. |
options | System.Text.Json.JsonSerializerOptions | The serializer options. |
