> ## Documentation Index
> Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DocsJsonConfig

> Represents the root configuration object for Mintlify docs.json.

## Definition

**Assembly:** Mintlify.Core.dll

**Namespace:** Mintlify.Core.Models

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
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

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor

#### Syntax

```csharp theme={"dark"}
public DocsJsonConfig()
```

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Api

Gets or sets the API reference configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ApiConfig Api { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ApiConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Appearance

Gets or sets the appearance configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.AppearanceConfig Appearance { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.AppearanceConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Background

Gets or sets the background configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.BackgroundConfig Background { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.BackgroundConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Banner

Gets or sets the banner configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.BannerConfig Banner { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.BannerConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Colors

Gets or sets the color configuration.

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Contextual

Gets or sets the contextual options configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ContextualConfig Contextual { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ContextualConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Description

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

#### Syntax

```csharp theme={"dark"}
public string Description { get; set; }
```

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Errors

Gets or sets the error pages configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.ErrorsConfig Errors { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.ErrorsConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Favicon

Gets or sets the favicon configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.FaviconConfig Favicon { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.FaviconConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Fonts

Gets or sets the fonts configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.FontsConfig Fonts { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.FontsConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Footer

Gets or sets the footer configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.FooterConfig Footer { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.FooterConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Icons

Gets or sets the icons configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.IconsConfig Icons { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.IconsConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Integrations

Gets or sets the integrations configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.IntegrationsConfig Integrations { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.IntegrationsConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Interaction

Gets or sets the interaction configuration for navigation elements.

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Logo

Gets or sets the logo configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.LogoConfig Logo { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.LogoConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Metadata

Gets or sets the metadata configuration for documentation pages.

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Name

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

#### Syntax

```csharp theme={"dark"}
public string Name { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

This is a required field.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Navbar

Gets or sets the navbar configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.NavbarConfig Navbar { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.NavbarConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Navigation

Gets or sets the navigation structure.

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Redirects

Gets or sets the redirects.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<Mintlify.Core.Models.RedirectConfig> Redirects { get; set; }
```

#### Property Value

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

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Schema

Gets or sets the JSON schema URL.

#### Syntax

```csharp theme={"dark"}
public string Schema { get; set; }
```

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Search

Gets or sets the search configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.SearchConfig Search { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.SearchConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Seo

Gets or sets the SEO configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.SeoConfig Seo { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.SeoConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Styling

Gets or sets the styling configuration.

#### Syntax

```csharp theme={"dark"}
public Mintlify.Core.Models.StylingConfig Styling { get; set; }
```

#### Property Value

Type: `Mintlify.Core.Models.StylingConfig?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Theme

Gets or sets the theme name.

#### Syntax

```csharp theme={"dark"}
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.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Thumbnails

Gets or sets the thumbnails configuration.

#### Syntax

```csharp theme={"dark"}
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

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name  | Type      | Description |
| ----- | --------- | ----------- |
| `obj` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

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

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

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

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`