​
Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

​
Syntax

Mintlify.Core.Models.DocsJsonConfig

​
Summary

Represents the root configuration object for Mintlify docs.json.

​
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.

​
Constructors

​
.ctor

​
Syntax

public DocsJsonConfig()

​
Properties

​
Api

Gets or sets the API reference configuration.

​
Syntax

public Mintlify.Core.Models.ApiConfig Api { get; set; }

​
Property Value

Type: Mintlify.Core.Models.ApiConfig?

​
Appearance

Gets or sets the appearance configuration.

​
Syntax

public Mintlify.Core.Models.AppearanceConfig Appearance { get; set; }

​
Property Value

Type: Mintlify.Core.Models.AppearanceConfig?

​
Background

Gets or sets the background configuration.

​
Syntax

public Mintlify.Core.Models.BackgroundConfig Background { get; set; }

​
Property Value

Type: Mintlify.Core.Models.BackgroundConfig? Gets or sets the banner configuration.

​
Syntax

public Mintlify.Core.Models.BannerConfig Banner { get; set; }

​
Property Value

Type: Mintlify.Core.Models.BannerConfig?

​
Colors

Gets or sets the color configuration.

​
Syntax

public Mintlify.Core.Models.ColorsConfig Colors { get; set; }

​
Property Value

Type: Mintlify.Core.Models.ColorsConfig

​
Remarks

This is a required field. At minimum, the primary color must be defined.

​
Contextual

Gets or sets the contextual options configuration.

​
Syntax

public Mintlify.Core.Models.ContextualConfig Contextual { get; set; }

​
Property Value

Type: Mintlify.Core.Models.ContextualConfig?

​
Description

Gets or sets the optional description used for SEO and LLM indexing.

​
Syntax

public string Description { get; set; }

​
Property Value

Type: string?

​
Errors

Gets or sets the error pages configuration.

​
Syntax

public Mintlify.Core.Models.ErrorsConfig Errors { get; set; }

​
Property Value

Type: Mintlify.Core.Models.ErrorsConfig?

​
Favicon

Gets or sets the favicon configuration.

​
Syntax

public Mintlify.Core.Models.FaviconConfig Favicon { get; set; }

​
Property Value

Type: Mintlify.Core.Models.FaviconConfig?

​
Fonts

Gets or sets the fonts configuration.

​
Syntax

public Mintlify.Core.Models.FontsConfig Fonts { get; set; }

​
Property Value

Type: Mintlify.Core.Models.FontsConfig? Gets or sets the footer configuration.

​
Syntax

public Mintlify.Core.Models.FooterConfig Footer { get; set; }

​
Property Value

Type: Mintlify.Core.Models.FooterConfig?

​
Icons

Gets or sets the icons configuration.

​
Syntax

public Mintlify.Core.Models.IconsConfig Icons { get; set; }

​
Property Value

Type: Mintlify.Core.Models.IconsConfig?

​
Integrations

Gets or sets the integrations configuration.

​
Syntax

public Mintlify.Core.Models.IntegrationsConfig Integrations { get; set; }

​
Property Value

Type: Mintlify.Core.Models.IntegrationsConfig? Gets or sets the logo configuration.

​
Syntax

public Mintlify.Core.Models.LogoConfig Logo { get; set; }

​
Property Value

Type: Mintlify.Core.Models.LogoConfig?

​
Name

Gets or sets the name of the project, organization, or product.

​
Syntax

public string Name { get; set; }

​
Property Value

Type: string

​
Remarks

This is a required field. Gets or sets the navbar configuration.

​
Syntax

public Mintlify.Core.Models.NavbarConfig Navbar { get; set; }

​
Property Value

Type: Mintlify.Core.Models.NavbarConfig? Gets or sets the navigation structure.

​
Syntax

public Mintlify.Core.Models.NavigationConfig Navigation { get; set; }

​
Property Value

Type: Mintlify.Core.Models.NavigationConfig

​
Remarks

This is a required field that defines the structure of your documentation.

​
Redirects

Gets or sets the redirects.

​
Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.RedirectConfig> Redirects { get; set; }

​
Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.RedirectConfig>?

​
Schema

Gets or sets the JSON schema URL.

​
Syntax

public string Schema { get; set; }

​
Property Value

Type: string? Gets or sets the search configuration.

​
Syntax

public Mintlify.Core.Models.SearchConfig Search { get; set; }

​
Property Value

Type: Mintlify.Core.Models.SearchConfig?

​
Seo

Gets or sets the SEO configuration.

​
Syntax

public Mintlify.Core.Models.SeoConfig Seo { get; set; }

​
Property Value

Type: Mintlify.Core.Models.SeoConfig?

​
Styling

Gets or sets the styling configuration.

​
Syntax

public Mintlify.Core.Models.StylingConfig Styling { get; set; }

​
Property Value

Type: Mintlify.Core.Models.StylingConfig?

​
Theme

Gets or sets the theme name.

​
Syntax

public string Theme { get; set; }

​
Property Value

Type: string

​
Remarks

This is a required field. Valid values are: mint, maple, palm, willow, linden, almond, aspen.

​
Thumbnails

Gets or sets the thumbnails configuration.

​
Syntax

public System.Collections.Generic.Dictionary<string, string> Thumbnails { get; set; }

​
Property Value

Type: System.Collections.Generic.Dictionary<string, string>?

​
Remarks

Defines custom thumbnail images for social media sharing and link previews. Can include background images and other preview assets.