Skip to content

Conversation

@TudorCRL
Copy link

@TudorCRL TudorCRL commented Feb 18, 2025

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

@smainil
Copy link
Collaborator

smainil commented Feb 24, 2025

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
Copy link
Collaborator

smainil commented Feb 27, 2025

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

@smainil
Copy link
Collaborator

smainil commented Mar 5, 2025

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

@TudorCRL
Copy link
Author

TudorCRL commented Mar 5, 2025

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

@WillGibson
Copy link
Collaborator

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

I wonder what @tcort thinks on that front?

@github-actions
Copy link

github-actions bot commented May 8, 2025

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 github-actions bot added the Stale label May 8, 2025
@BaseMax
Copy link
Collaborator

BaseMax commented May 8, 2025

No update?

@github-actions github-actions bot removed the Stale label May 12, 2025
@github-actions
Copy link

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 github-actions bot added the Stale label Jul 11, 2025
@BaseMax
Copy link
Collaborator

BaseMax commented Jul 11, 2025

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.

@github-actions github-actions bot removed the Stale label Jul 12, 2025
@smainil
Copy link
Collaborator

smainil commented Sep 18, 2025

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 smainil mentioned this pull request Sep 18, 2025
@BaseMax
Copy link
Collaborator

BaseMax commented Sep 22, 2025

This branch has conflicts that must be resolved
@smainil

@BaseMax
Copy link
Collaborator

BaseMax commented Sep 22, 2025

cc @TudorCRL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants