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 broken-links crawls every MDX file in your project, identifies internal links that don’t resolve to an existing page, and suggests the closest matching path by name — so you can catch dead links before your readers do.

Usage

jamdesk broken-links

Example output

docs/getting-started.mdx:15 - /docs/quikstart
  Did you mean: /docs/quickstart

Found 1 broken link in 45 files.
Each result shows the file and line number where the broken link appears, followed by the suggested replacement. The summary line tells you how many broken links were found and how many files were scanned.

Flags

FlagDescription
--verbosePrint each file name as it is scanned

Tips

Add jamdesk broken-links to your CI pipeline and run it before every deploy. Catching broken links in review is much easier than fixing them after they reach readers.
broken-links only checks internal links — paths that point to other pages within your docs. It does not validate external URLs such as https://example.com.

Build docs developers (and LLMs) love