DocsJsonValidator

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

Syntax

public class DocsJsonValidator

Inheritance

Methods

Validate

public List<string> Validate(DocsJsonConfig config)
Validates a docs.json configuration against the Mintlify schema.

Parameters

Returns

List<string> A list of validation errors. Empty if configuration is valid.

ValidateAppearance

public void ValidateAppearance(DocsJsonConfig config, List<string> errors)
Validates the appearance configuration.

Parameters

ValidateColors

public void ValidateColors(DocsJsonConfig config, List<string> errors)
Validates the color configuration.

Parameters

ValidateIcons

public void ValidateIcons(DocsJsonConfig config, List<string> errors)
Validates the icons configuration.

Parameters

public void ValidateLogo(DocsJsonConfig config, List<string> errors)
Validates the logo configuration.

Parameters

ValidateNavigation

public void ValidateNavigation(DocsJsonConfig config, List<string> errors)
Validates the navigation configuration.

Parameters

ValidateRequired

public void ValidateRequired(DocsJsonConfig config, List<string> errors)
Validates that the configuration has all required properties.

Parameters

ValidateSeo

public void ValidateSeo(DocsJsonConfig config, List<string> errors)
Validates the SEO configuration.

Parameters

ValidateTheme

public void ValidateTheme(DocsJsonConfig config, List<string> errors)
Validates the theme configuration.

Parameters

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.