Documentation Index
Fetch the complete documentation index at: https://mintlify.com/jamdesk/jamdesk-cli/llms.txt
Use this file to discover all available pages before exploring further.
jamdesk validate scans your project for configuration errors, MDX syntax problems, and navigation inconsistencies — giving you a clear, line-level error report you can act on before committing or deploying. It is the same validation the dev server runs automatically on startup, and it is the right first step when something looks wrong.
Usage
docs.json).
What gets checked
docs.jsonschema — validates your configuration against the full Jamdesk spec, catching unknown keys, missing required fields, and invalid values.- MDX syntax — parses every
.mdxfile and reports syntax errors with file name, line number, and a plain-language fix. The most common issue is a<character being interpreted as the start of a JSX tag (for example,<50%). - OpenAPI specs — if OpenAPI is configured in
docs.json, each referenced spec is validated for structural correctness. - Navigation — warns when a page listed in the
docs.jsonnavigation does not have a corresponding MDX file on disk.
Flags
Skip MDX syntax checks and only validate
docs.json and navigation. Useful for a quick config check when you know your MDX is already clean.Print each file name as it is checked, and include additional detail in any error messages.
Example output
When an MDX syntax error is found,jamdesk validate reports the file, line number, raw parser message, and a human-readable fix:
0 and prints a success summary.
jamdesk openapi-check
To validate a single OpenAPI spec file without running a full project validation, use the openapi-check subcommand:
openapi-check is useful for validating a spec in isolation — for example, when a backend team owns the spec file and you want to confirm it is valid before wiring it into docs.json.