NavigationJsonConverter

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Converters Inheritance: System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.NavigationConfig>

Syntax

Mintlify.Core.Converters.NavigationJsonConverter

Summary

Custom JSON converter for navigation that outputs simple array format for Mintlify compatibility.

Constructors

.ctor

Syntax

public NavigationJsonConverter()

Methods

Read Override

Reads navigation from JSON, supporting both array and object formats.

Syntax

public override Mintlify.Core.Models.NavigationConfig Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options)

Parameters

Name	Type	Description
`reader`	`System.Text.Json.Utf8JsonReader`	-
`typeToConvert`	`System.Type`	-
`options`	`System.Text.Json.JsonSerializerOptions`	-

Returns

Type: Mintlify.Core.Models.NavigationConfig?

Write Override

Writes navigation to JSON in the appropriate format for Mintlify compatibility.

Syntax

public override void Write(System.Text.Json.Utf8JsonWriter writer, Mintlify.Core.Models.NavigationConfig value, System.Text.Json.JsonSerializerOptions options)

Parameters

Name	Type	Description
`writer`	`System.Text.Json.Utf8JsonWriter`	-
`value`	`Mintlify.Core.Models.NavigationConfig`	-
`options`	`System.Text.Json.JsonSerializerOptions`	-

Getting Started

Guides

Providers

Plugins

Learnings

API Reference

NavigationJsonConverter

Definition

Syntax

Summary

Constructors

.ctor

Syntax

Methods

Read Override

Syntax

Parameters

Returns

Write Override

Syntax

Parameters

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​Methods

​ Read Override

​Syntax

​Parameters

​Returns

​ Write Override

​Syntax

​Parameters

Definition

Syntax

Summary

Constructors

.ctor

Syntax

Methods

Read Override

Syntax

Parameters

Returns

Write Override

Syntax

Parameters