Skip to main content

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 spellcheck scans every page in your docs for spelling errors using an English dictionary augmented with 150+ built-in tech terms — including API, GraphQL, Kubernetes, and other common jargon — so industry vocabulary doesn’t produce false positives. Run --fix to step through each misspelling interactively and either correct it or add it to your project’s ignore list.

​
Usage

jamdesk spellcheck [options]

​
Example output

getting-started.mdx:14 - "recieve"
  └─ Did you mean: receive

Found 3 misspellings across 24 pages.
Tip: Run "jamdesk spellcheck --fix" to interactively fix or ignore words.
Each result includes the file name, line number, the misspelled word, and the best suggestion. The summary shows the total count of misspellings and the number of pages checked.

​
Flags

FlagDescription
--fixInteractively fix misspellings or add words to the ignore list
--jsonOutput results as JSON (useful for CI pipelines)
--verbosePrint each file name as it is checked

​
--fix mode

Running jamdesk spellcheck --fix steps through each unique misspelled word one at a time and presents you with a choice:
  • Fix → Replace the word with one of up to three suggestions across every file where it appears. The best match is marked as recommended.
  • Ignore — Add the word to spellcheck.ignore in docs.json so it won’t be flagged in future runs.
  • Skip — Take no action for this run; the word remains in the output next time.
All changes are previewed before they are applied. The command is prose-safe: it will not modify words inside code blocks, inline code, or JSX attributes. Your project name from docs.json is automatically added to the ignore list.

​
Configuration

Add project-specific words to the spellcheck.ignore list in docs.json to suppress false positives for product names, internal terminology, or uncommon proper nouns: 
{
  "spellcheck": {
    "ignore": ["YourProduct", "kubectl"]
  }
}
Words in this list are excluded from every spellcheck run, including in CI.

​
Limitations

jamdesk spellcheck currently supports English only. Multi-language support is planned for a future release.

Build docs developers (and LLMs) love

Get started for freeTalk to us