​
Definition

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

​
Syntax

Mintlify.Core.DocsJsonValidator

​
Summary

Validates Mintlify docs.json configuration against the official schema requirements.

​
Remarks

This class provides comprehensive validation of the docs.json configuration to ensure it complies with the Mintlify schema and will work correctly when deployed.

​
Constructors

​
.ctor

​
Syntax

public DocsJsonValidator()

​
Methods

​
Validate

Validates a docs.json configuration against the Mintlify schema.

​
Syntax

public System.Collections.Generic.List<string> Validate(Mintlify.Core.Models.DocsJsonConfig config)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.

​
Returns

Type: System.Collections.Generic.List<string> A list of validation errors. Empty if configuration is valid.

​
ValidateApi

Validates the API configuration.

​
Syntax

public void ValidateApi(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateAppearance

Validates the appearance configuration.

​
Syntax

public void ValidateAppearance(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateColors

Validates the color configuration.

​
Syntax

public void ValidateColors(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateGroups

Validates group configurations in navigation.

​
Syntax

public void ValidateGroups(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateIcons

Validates the icons configuration.

​
Syntax

public void ValidateIcons(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.
Validates the logo configuration.

​
Syntax

public void ValidateLogo(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateNavigation

Validates the navigation configuration.

​
Syntax

public void ValidateNavigation(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateRequired

Validates that the configuration has all required properties.

​
Syntax

public void ValidateRequired(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateSeo

Validates the SEO configuration.

​
Syntax

public void ValidateSeo(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.

​
ValidateTheme

Validates the theme configuration.

​
Syntax

public void ValidateTheme(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

​
Parameters

NameTypeDescription
configMintlify.Core.Models.DocsJsonConfigThe configuration to validate.
errorsSystem.Collections.Generic.List<string>The list to add errors to.