Mintlify MDX extension - #7108
Merged
Merged
Conversation
Add a page for the Mintlify MDX extension (mintlify.mintlify-snippets), which had no coverage outside a 2024 changelog entry describing its snippets-only predecessor. Covers autocomplete, diagnostics, hover docs, go-to-definition, docs.json schema validation, the in-editor preview panel, surround snippets, all four settings, and all five commands, verified against the shipped v2.0.0 manifest and bundle. Replace the unifiedjs.vscode-mdx recommendation in cli/install.mdx. Our extension warns users to disable that one, so the previous guidance routed them into a known conflict. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The vocabulary had a bare `prefetching` entry, so `prefetches` and `prefetched` in cli/preview.mdx were flagged as misspellings. Vale wraps entries in \b, so the bare form matches only that one variant. Use `(?i)prefetch(es|ed|ing)?` rather than the uncased suffix pattern used by neighboring entries. An uncased entry also generates a case-enforcing Vale.Terms rule, which would flag a sentence-initial "Prefetching" as an error. "prefetch" has no canonical capitalization worth enforcing, so the non-enforcing form avoids a latent false positive. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
documents new Mintlify MDX extension
Closes https://linear.app/mintlify/issue/DOC-424/document-new-mintlify-mdx-vs-code-extension
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Documentation-only changes with no runtime impact; verify
docs.jsonnav slug matchescli/mdx-extensionso the new page is reachable.Overview
Adds a new Mintlify MDX extension page (
cli/mdx-extension.mdx) covering install, autocomplete, diagnostics, hover docs, go-to-definition,docs.jsonvalidation, in-editor preview viamint dev, surround-with snippets, settings/commands, conflicting extensions, and troubleshooting.Updates the CLI docs to point authors at that extension instead of the generic MDX VS Code plugin: Editor support on install, a Next steps link on the CLI index, and a Tip on local preview describing the side-by-side editor preview.
Expands the Vale allowlist so prefetch inflections pass spellcheck.
Reviewer note:
docs.jsonstill registerscli/vs-code-extensionwhile the new page slug iscli/mdx-extension—confirm nav resolves or align the path.Reviewed by Cursor Bugbot for commit 1ebce22. Bugbot is set up for automated code reviews on this repo. Configure here.