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.

Renaming a file in a docs project is rarely just a file-system operation — every navigation entry, internal link, and snippet import that references the old path breaks the moment the file moves. jamdesk rename handles all of that in one step: it moves the file to its new location and rewrites every reference across your project automatically, so nothing is left pointing at a path that no longer exists.

Usage

jamdesk rename <from> <to>
Argument / FlagDescription
<from>Current path of the MDX file, relative to the project root (e.g., docs/old-name.mdx)
<to>New path for the file, relative to the project root (e.g., docs/new-name.mdx)
--verbosePrint each file updated as references are rewritten

Example

jamdesk rename docs/old-name.mdx docs/new-name.mdx

What Gets Updated

When you run jamdesk rename, the following are automatically rewritten to use the new path:
  • docs.json navigation — any pages entry that referenced the old filename is updated to the new one
  • Internal links — Markdown and MDX links (e.g., [text](/docs/old-name)) throughout your content are rewritten
  • Snippet importsimport statements in MDX files that pull from the renamed file are updated to the new path
Run jamdesk rename from your project root — the directory where docs.json lives. The command uses docs.json to locate your project structure and determine which files need updating.
After renaming, run jamdesk dev to preview the site and confirm everything looks correct. The dev server will validate your navigation and catch any references that may have been missed.

Build docs developers (and LLMs) love