# @mintlify/validation

> Validates mint.json files

Latest version **0.1.873** (published 2026-09-24) · Elastic-2.0 license · 0 weekly downloads

## Install

```sh
npm install @mintlify/validation
pnpm add @mintlify/validation
yarn add @mintlify/validation
bun add @mintlify/validation
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.1.873 |
| Published | 2026-09-24 |
| First published | 2023-01-03 |
| Weekly downloads | 0 |
| License | Elastic-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 12 |
| Unpacked size | 4 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Mintlify, Inc. |
| Maintainers | dks333, hanmint, hahnbee, shouchem-mintlify, kylefinken, lucaspunz |
| Keywords | mintlify, mint, validation |

## Links

- npm: https://www.npmjs.com/package/@mintlify/validation
- Repository: https://github.com/mintlify/mint
- Homepage: https://github.com/mintlify/mint#readme
- Issues: https://github.com/mintlify/docs/issues
- npm.io page: https://npm.io/package/@mintlify/validation

## Dependencies (12)

- [lcm](https://npm.io/package/lcm.md) 0.0.3
- [zod](https://npm.io/package/zod.md) 3.24.0
- [uuid](https://npm.io/package/uuid.md) 11.1.1
- [lodash](https://npm.io/package/lodash.md) 4.18.1
- [js-yaml](https://npm.io/package/js-yaml.md) 4.3.1
- [neotraverse](https://npm.io/package/neotraverse.md) 0.6.18
- [object-hash](https://npm.io/package/object-hash.md) 3.0.0
- [@mintlify/mdx](https://npm.io/package/@mintlify/mdx.md) 4.0.6
- [openapi-types](https://npm.io/package/openapi-types.md) 12.1.3
- [@mintlify/models](https://npm.io/package/@mintlify/models.md) 0.0.362
- [zod-to-json-schema](https://npm.io/package/zod-to-json-schema.md) 3.20.4
- [fractional-indexing](https://npm.io/package/fractional-indexing.md) 3.2.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.873 (latest) — 2026-09-24
- 0.1.872 — 2026-09-24
- 0.1.871 — 2026-09-24
- 0.1.870 — 2026-09-24
- 0.1.869 — 2026-09-23
- 0.1.868 — 2026-09-22
- 0.1.867 — 2026-09-22
- 0.1.866 — 2026-09-22
- 0.1.865 — 2026-09-22
- 0.1.864 — 2026-09-21
- 0.1.863 — 2026-09-21
- 0.1.862 — 2026-09-21
- 0.1.861 — 2026-09-19
- 0.1.860 — 2026-09-19
- 0.1.859 — 2026-09-18
- … 861 more at https://npm.io/package/@mintlify/validation/versions

## README

# @mintlify/validation

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

# Installation

```bash
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](https://mintlify.com/docs/settings/global).

# Community

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

[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)

_Built with 💚 by the Mintlify community._

---
_Source: https://npm.io/package/@mintlify/validation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._