Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add markdown support for .mdx files #1730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2023
Merged

Conversation

ctmayn
Copy link
Contributor

@ctmayn ctmayn commented Oct 10, 2023

Implements https://github.com/github/repos/issues/8873

Adds basic support for rendering .mdx files as markdown. Non-markdown syntax will just be printed out as plain text

Copy link

@AdamShwert AdamShwert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ctmayn ctmayn merged commit a849a12 into master Oct 11, 2023
@wooorm
Copy link

wooorm commented Mar 26, 2024

Hi! MDX person here. Looks like this is now alive on the website.

I’m not sure this is a good idea. There are some MDX files that are indeed close to markdown. But this also looks really bad for other files. Some examples:

MDX-the-language has a benefit for programmers that want to use their own React/Vue/etc components.
MDX users can also use .md files with plain markdown if they don’t need to program or use components and want to be compatible with GH.
I believe that seeing code is fine for programmers.

The “Non-markdown syntax will just be printed out as plain text” is not correct, as can be seen.

What is the reasoning in 8873? Can I convince the people in that discussion that this may not be an improvement?

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.

3 participants