@mintlify/validation

@mintlify/validation

@mintlify/validation is a small package to validate docs.json files.

Installation

npm install @mintlify/validation

Usage

import mintValidation from "@mintlify/validation"

const configObject = { name: "Site Name", navigation: [] }

mintValidation.validateMintConfig(configObject)
mintValidation.validateDocsConfig(configObject)

This package assumes you have already loaded a config object into a JavaScript object.

Return Values

The package returns an object with the properties status, warnings, and errors.

status can be one of: "success", "error".

warnings is a string array with warnings the user should know but are not expected to break the site.

errors is a string array of errors that will likely break the site.

When status === "error" you should stop trying to build mint, your docs.json file is invalid and the site will crash when building.

Return Value Example

{
    "status": "error",
    "warnings": ["Navigation is an empty array, no pages will be shown"],
    "errors": ["Mintlify does not support .ico favicons, use .svg or .png instead."]
}

Documentation

Additional documentation on docs.json is available on Mintlify's website.

Community

Join our Discord community if you have questions or just want to chat:

Built with 💚 by the Mintlify community.

Similar packages

Other packages similar to @mintlify/validation

zod

A TypeScript-first library for defining schemas and validating data at runtime. It is more general-purpose and lets you define application-specific rules; Mintlify validation is oriented toward Mintlify documentation inputs.

ajv

A high-performance JSON Schema validator. It is a good fit when you already have JSON Schemas or need standards-based validation across many kinds of JSON data, whereas Mintlify validation is tailored to Mintlify workflows.

@redocly/cli

A command-line tool for linting, validating, and managing OpenAPI descriptions. It focuses on OpenAPI authoring and API governance, while Mintlify validation is aimed at validation in a Mintlify documentation context.

openapi-schema-validator

Validates OpenAPI documents against supported OpenAPI schemas. It is narrower and focused on OpenAPI conformance rather than Mintlify documentation configuration.