@mintlify/validation NPM | npm.io

0.1.149 • Published 1 day ago

Install

Weekly downloads

-

License

Elastic-2.0

Repository

Last release

1 day ago

@mintlify/validation

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

Installation

npm install @mintlify/validation

Usage

import mintValidation from "@mintlify/validation"

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

mintValidation.validateMintConfig(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 mint.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 mint.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 @mintlify/cli @mintlify/common @mintlify/http-client @mintlify/prebuild @mintlify/previewing

1 day ago

1 day ago

2 days ago

6 days ago

11 days ago

17 days ago

18 days ago

19 days ago

21 days ago

24 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

10 months ago

10 months ago

10 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

8 months ago

8 months ago

7 months ago

7 months ago

7 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

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

5 months ago

6 months ago

6 months ago

5 months ago

5 months ago

6 months ago

6 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

12 months ago

11 months ago

11 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