DocsJsonConfig

Represents the root configuration object for Mintlify docs.json.

Syntax

public class DocsJsonConfig

Inheritance

Properties

Api

[JsonPropertyName("api")]
public ApiConfig Api { get; set; }
Gets or sets the API reference configuration.

Returns

ApiConfig

Appearance

[JsonPropertyName("appearance")]
public AppearanceConfig Appearance { get; set; }
Gets or sets the appearance configuration.

Returns

AppearanceConfig

Background

[JsonPropertyName("background")]
public BackgroundConfig Background { get; set; }
Gets or sets the background configuration.

Returns

BackgroundConfig
[JsonPropertyName("banner")]
public BannerConfig Banner { get; set; }
Gets or sets the banner configuration.

Returns

BannerConfig

Colors

[JsonPropertyName("colors")]
public ColorsConfig Colors { get; set; }
Gets or sets the color configuration.

Returns

ColorsConfig

Contextual

[JsonPropertyName("contextual")]
public ContextualConfig Contextual { get; set; }
Gets or sets the contextual options configuration.

Returns

ContextualConfig

Description

[JsonPropertyName("description")]
public string Description { get; set; }
Gets or sets the optional description used for SEO and LLM indexing.

Returns

string

Errors

[JsonPropertyName("errors")]
public ErrorsConfig Errors { get; set; }
Gets or sets the error pages configuration.

Returns

ErrorsConfig

Favicon

[JsonPropertyName("favicon")]
public FaviconConfig Favicon { get; set; }
Gets or sets the favicon configuration.

Returns

FaviconConfig

Fonts

[JsonPropertyName("fonts")]
public FontsConfig Fonts { get; set; }
Gets or sets the fonts configuration.

Returns

FontsConfig
[JsonPropertyName("footer")]
public FooterConfig Footer { get; set; }
Gets or sets the footer configuration.

Returns

FooterConfig

Icons

[JsonPropertyName("icons")]
public IconsConfig Icons { get; set; }
Gets or sets the icons configuration.

Returns

IconsConfig

Integrations

[JsonPropertyName("integrations")]
public IntegrationsConfig Integrations { get; set; }
Gets or sets the integrations configuration.

Returns

IntegrationsConfig
[JsonPropertyName("logo")]
public LogoConfig Logo { get; set; }
Gets or sets the logo configuration.

Returns

LogoConfig

Name

[JsonPropertyName("name")]
public string Name { get; set; }
Gets or sets the name of the project, organization, or product.

Returns

string
[JsonPropertyName("navbar")]
public NavbarConfig Navbar { get; set; }
Gets or sets the navbar configuration.

Returns

NavbarConfig
[JsonPropertyName("navigation")]
[JsonConverter(typeof(NavigationJsonConverter))]
public NavigationConfig Navigation { get; set; }
Gets or sets the navigation structure.

Returns

NavigationConfig

Redirects

[JsonPropertyName("redirects")]
public List<RedirectConfig> Redirects { get; set; }
Gets or sets the redirects.

Returns

List<RedirectConfig>

Schema

[JsonPropertyName("$schema")]
public string Schema { get; set; }
Gets or sets the JSON schema URL.

Returns

string
[JsonPropertyName("search")]
public SearchConfig Search { get; set; }
Gets or sets the search configuration.

Returns

SearchConfig

Seo

[JsonPropertyName("seo")]
public SeoConfig Seo { get; set; }
Gets or sets the SEO configuration.

Returns

SeoConfig

Styling

[JsonPropertyName("styling")]
public StylingConfig Styling { get; set; }
Gets or sets the styling configuration.

Returns

StylingConfig

Theme

[JsonPropertyName("theme")]
public string Theme { get; set; }
Gets or sets the theme name.

Returns

string

Remarks

This class represents the complete structure of a Mintlify docs.json configuration file as defined by the official Mintlify schema. It supports all themes and configuration options.