markdown-link-check icon indicating copy to clipboard operation
markdown-link-check copied to clipboard

Add mdx support to cli

Open TudorCRL opened this issue 10 months ago • 13 comments

Add a new option to the CLI tool --include-mdx. When running the CLI, check .mdx files if --include-mdx is set to true.

@tcort I don't know if you'd be interested in including this as a feature? We need it at my org for our internal checks on our docs, let me know what you think

TudorCRL avatar Feb 18 '25 16:02 TudorCRL

As MDX is a superset of markdown, perhaps this library could look for md and mdx files directly (without the need of an extra parameter) @tcort @WillGibson @BaseMax any thought about that ?

smainil avatar Feb 24 '25 12:02 smainil

@TudorCRL could you make changes to search for .md or .mdx files without the need of an extra option ?

smainil avatar Feb 27 '25 07:02 smainil

Without any answer by this weekend, I will close this PR without merging and create the changes myself

smainil avatar Mar 05 '25 06:03 smainil

Hi @smainil, apologies for not getting back to you, just got back from holiday! I'm happy to make that change, just one thought on that is that this change causes the checker to pick up on links that it previously would have ignored so won't be backwards compatible. But if you're fine with that I can push that change soon

TudorCRL avatar Mar 05 '25 10:03 TudorCRL

@TudorCRL That's a good point about it perhaps being a breaking change.

I wonder what @tcort thinks on that front?

WillGibson avatar Mar 05 '25 11:03 WillGibson

This pull request has been marked as stale because it has been open 60 days with no activity. It will be closed in 30 days unless the stale label is removed or someone adds a comment.

github-actions[bot] avatar May 08 '25 08:05 github-actions[bot]

No update?

BaseMax avatar May 08 '25 14:05 BaseMax

This pull request has been marked as stale because it has been open 60 days with no activity. It will be closed in 30 days unless the stale label is removed or someone adds a comment.

github-actions[bot] avatar Jul 11 '25 08:07 github-actions[bot]

What is MDX?

An MDX file is a file format that combines Markdown and JSX (JavaScript XML), allowing for the embedding of interactive components within Markdown documents. This means you can write content using Markdown's familiar syntax while also incorporating React components directly into the text.

BaseMax avatar Jul 11 '25 12:07 BaseMax

As we also have another PR for supporting qmd file extension (#478) maybe we should allow users to set a list of file extensions (.md would be set by default if not provided). Will try to have a look into it

smainil avatar Sep 18 '25 05:09 smainil

This branch has conflicts that must be resolved @smainil

BaseMax avatar Sep 22 '25 17:09 BaseMax

cc @TudorCRL

BaseMax avatar Sep 22 '25 17:09 BaseMax

This branch has conflicts that must be resolved

BaseMax avatar Nov 17 '25 15:11 BaseMax