@mintlify/validation NPM

@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.

mintlify mint validation

@mintlify/models lcm lodash openapi-types zod zod-to-json-schema

@tonyyanga/mintlify_previewing @infinitebrahmanuniverse/nolb-_mint @everything-registry/sub-chunk-607 @zalastax/nolb-_mint @octomind/octomind-mint-mcp @mintlify/prebuild @mintlify/previewing @mintlify/mcp @mintlify/http-client @mintlify/cli @mintlify/common @amp-labs/mcp-docs-server

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

10 months ago

5 months ago

10 months ago

5 months ago

9 months ago

5 months ago

9 months ago

6 months ago

10 months ago

6 months ago

5 months ago

9 months ago

5 months ago

9 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

9 months ago

5 months ago

5 months ago

9 months ago

5 months ago

9 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

7 months ago

7 months ago

8 months ago

8 months ago

7 months ago

11 months ago

7 months ago

11 months ago

11 months ago

7 months ago

11 months ago

7 months ago

12 months ago

7 months ago

12 months ago

7 months ago

11 months ago

7 months ago

11 months ago

7 months ago

7 months ago

12 months ago

7 months ago

6 months ago

10 months ago

6 months ago

10 months ago

10 months ago

7 months ago

11 months ago

7 months ago

11 months ago

6 months ago

10 months ago

6 months ago

11 months ago

7 months ago

11 months ago

7 months ago

7 months ago

11 months ago

7 months ago

11 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

5 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

5 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

1 year ago

1 year ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago