Skip to content
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

More details needed for adding MDX support #11

Open
pandaa880 opened this issue May 30, 2021 · 3 comments
Open

More details needed for adding MDX support #11

pandaa880 opened this issue May 30, 2021 · 3 comments

Comments

@pandaa880
Copy link

Hi,
I would like to work on adding MDX support if it is not taken by someone else yet. I have few questions for this.

  • After adding MDX support will .md files coexist with .mdx files ? Meaning we can either write in .md or .mdx.
  • Are we going to use MDX parsing for .md files ?
  • Will .mdx files treated directly as pages or it will follow same structure as .md files ?
@vickonrails
Copy link
Owner

vickonrails commented Jun 4, 2021

Hey there @pandaa880. I have plans to work add mdx support, but sure, you can work on it.

For your questions

After adding MDX support, will .md files coexist with .mdx files? Meaning we can either write in .md or .mdx

We could have them co-exist if possible. But what's the use case for using mdx and md together since mdx is a superset of md?

Are we going to use MDX parsing for .md files?

I really don't know how this would work. peacock currently uses remark for parsing .md file. But you can try anything.

Will .mdx files treated directly as pages or it will follow the same structure as .md files?

You can try as much as possible to follow the current structure. Basically limiting mdx support to just content pages.

I really don't know how to go about this too. But I'm open-minded and will learn a lot from your implementation. Maybe you should just send a pull request if possible, we could discuss further improvements after then.

Thanks

@pandaa880
Copy link
Author

I also don't see a case to keep both .md and .mdx files together. I was just not sure if we would replace the current flow of .md files with .mdx. Anyway, we will only use .mdx files.
I agree with you for the improvement part. Let's create a basic implementation first and then we can discuss further.

@vickonrails
Copy link
Owner

Great. Great.

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

No branches or pull requests

2 participants