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

Parse MyST Markdown using Remark #1705

Open
mettekou opened this issue Dec 19, 2024 · 2 comments
Open

Parse MyST Markdown using Remark #1705

mettekou opened this issue Dec 19, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@mettekou
Copy link

mettekou commented Dec 19, 2024

Proposal

I've been an avid user of MyST Markdown and greatly appreciate the work you've done to enhance scientific writing. I believe you're always looking for ways to enhance MyST Markdown's capabilities. Have you considered the potential benefits of switching from markdown-it to Remark? I'd love to hear your thoughts on this. Would you be open to exploring how Remark could potentially benefit MyST Markdown?

@mettekou mettekou added the enhancement New feature or request label Dec 19, 2024
@choldgraf
Copy link
Collaborator

Thanks for the suggestion - this would require discussion and research before making any kinds of decisions, so I suspect it will be some time before folks get to this because of the limited developer / maintainer capacity on the project. You could certainly write a MyST parser that uses Remark - so a nice starting point might be to implement something and show it off to see how it would be more beneficial than markdown-it (or potentially maintained as a parallel community effort).

@rowanc1
Copy link
Member

rowanc1 commented Jan 14, 2025

Thanks for the suggestion @mettekou -- this is something we have thought about a lot, and agree that there are a ton of benefits to enabling this direction. We have done a few prototypes and really like using unified for the parser. There is some history to why we are using markdown-it, as well as a few benefits to having that parser for the vscode ecosystem. However, unified gives column positioning and is how we are doing the rest of the transforms and plugins after parsing is complete. The unified and remark ecosystem is also a bit larger for other types of plugins (e.g. mdx).

I am hoping that we get to this, at least in an experiment, in the next several months. Any help/encouragement via use cases that you could provide @mettekou in that direction would be greatly appreciated! 🚀

@choldgraf I don't think that we would necessarily give up on the markdown-it parser, but having the unified parser that is compatible with remark does open up a lot of possibilities, especially for enabling javascript developers. Perhaps @mettekou can give some more details as to the use case you are thinking about?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants