DocsJsonConfig - DotNetDocs

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()

.ctor Inherited

Inherited from object

Syntax

public Object()

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?

Interaction

Gets or sets the interaction configuration for navigation elements.

Syntax

public Mintlify.Core.Models.InteractionConfig Interaction { get; set; }

Property Value

Type: Mintlify.Core.Models.InteractionConfig?

Remarks

Controls how users interact with navigation elements such as groups and dropdowns, including whether expanding a group automatically navigates to its first page.

Logo

Gets or sets the logo configuration.

Syntax

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

Property Value

Type: Mintlify.Core.Models.LogoConfig?

Metadata

Gets or sets the metadata configuration for documentation pages.

Syntax

public Mintlify.Core.Models.MetadataConfig Metadata { get; set; }

Property Value

Type: Mintlify.Core.Models.MetadataConfig?

Remarks

Controls page-level metadata features such as displaying the last modified timestamp on documentation pages.

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?

Search

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 Mintlify.Core.Models.ThumbnailsConfig Thumbnails { get; set; }

Property Value

Type: Mintlify.Core.Models.ThumbnailsConfig?

Remarks

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

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​Properties

​ Api

​Syntax

​Property Value

​ Appearance

​Syntax

​Property Value

​ Background

​Syntax

​Property Value

​ Banner

​Syntax

​Property Value

​ Colors

​Syntax

​Property Value

​Remarks

​ Contextual

​Syntax

​Property Value

​ Description

​Syntax

​Property Value

​ Errors

​Syntax

​Property Value

​ Favicon

​Syntax

​Property Value

​ Fonts

​Syntax

​Property Value

​ Footer

​Syntax

​Property Value

​ Icons

​Syntax

​Property Value

​ Integrations

​Syntax

​Property Value

​ Interaction

​Syntax

​Property Value

​Remarks

​ Logo

​Syntax

​Property Value

​ Metadata

​Syntax

​Property Value

​Remarks

​ Name

​Syntax

​Property Value

​Remarks

​ Navbar

​Syntax

​Property Value

​ Navigation

​Syntax

​Property Value

​Remarks

​ Redirects

​Syntax

​Property Value

​ Schema

​Syntax

​Property Value

​ Search

​Syntax

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

Properties

Api

Syntax

Property Value

Appearance

Syntax

Property Value

Background

Syntax

Property Value

Banner

Syntax

Property Value

Colors

Syntax

Property Value

Remarks

Contextual

Syntax

Property Value

Description

Syntax

Property Value

Errors

Syntax

Property Value

Favicon

Syntax

Property Value

Fonts

Syntax

Property Value

Footer

Syntax

Property Value

Icons

Syntax

Property Value

Integrations

Syntax

Property Value

Interaction

Syntax

Property Value

Remarks

Logo

Syntax

Property Value

Metadata

Syntax

Property Value

Remarks

Name

Syntax

Property Value

Remarks

Navbar

Syntax

Property Value

Navigation

Syntax

Property Value

Remarks

Redirects

Syntax

Property Value

Schema

Syntax

Property Value

Search

Syntax