Refactor to improve wording

[filippovd20]

importing mdx not md

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)
• If applicable, I’ve added docs and tests

Description of changes

Fixing a typo in the code snipped importing from mdx not md directly.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
mdx	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 16, 2024 9:24am

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (908ff45) to head (e5d01a0).
Report is 40 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #2513   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        23           
  Lines         2693      2712   +19     
  Branches         2         2           
=========================================
+ Hits          2693      2712   +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wooorm]

Hi! Why do you think this is a mistake? I think this is intended!

[remcohaszing]

I think the comment should say Assumes an integration is used to compile markdown -> JS., not Assumes an integration is used to compile MDX -> JS..

[wooorm]

I kinda get what you're saying but saying "md" there feels a bit more static. Like using marked/remark/markdown-it.
Perhaps the "to JS" part cancels that out enough.
The point, I think, when I added those comments, is that it doesn't work normally, to import these files. They need some integration, not one particular one. Likely one of ours, but not always.

[filippovd20]

@wooorm @remcohaszing if you look into the code snippet from post.mdx, both License and Contributing are regular components with props. Contributing is imported from an mdx module assuming everything is configured as expected. License on the other hand is imported from .md which is definitely a typo. There's no way you can import a component from an md file directly. If you could do that then why bother about mdx then?

[wooorm]

There's no way you can import a component from an md file directly. If you could do that then why bother about mdx then?

Yes you can, our packages can do that! Please see what MDX is, particularly this note: https://mdxjs.com/docs/what-is-mdx/#mdx-syntax.
Well, one reason where you go wrong: markdown doesn’t have imports so markdown couldn’t import markdown.

[filippovd20]

@wooorm I'm wrong and you're right. Indeed with the bundler configured it also compiles regular markdown to JS which is also described in Quick Start. Do you think changing the comment would be beneficial to stress the fact that md is also compiled to JS? something like this:
// Assumes a bundler is used to compile MD -> JS

[wooorm]

thanks :)