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

No longer a canonical way to parse a simple snippet #879

Open
micimize opened this issue Feb 29, 2024 · 4 comments
Open

No longer a canonical way to parse a simple snippet #879

micimize opened this issue Feb 29, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@micimize
Copy link

Describe the gap in the current documentation

Old docs used to have the following, but I cannot find the new equivalent

from myst_parser.main import to_html
to_html("some *text* {literal}`a`")

Describe the solution you'd like

Documnetation covering how to parse myst for simple usages i.e. display(HTML(parse_myst_to_html(markdown)))

@micimize micimize added the documentation Improvements or additions to documentation label Feb 29, 2024
Copy link

welcome bot commented Feb 29, 2024

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@micimize
Copy link
Author

Different question – mystmd and myst-parser docs differ in places (https://mystmd.org/guide/code#numbering-and-highlighting vs https://myst-parser.readthedocs.io/en/latest/syntax/code_and_apis.html#adding-a-caption) . I was hoping these would be consistent flavors I could use across notebooks, frontend apps, etc. Are these docs out of date or just a hiccup/slight out-of-sync state between the libraries?

@rowanc1
Copy link
Member

rowanc1 commented Feb 29, 2024

The goal of MyST as a markup language is to be consistent across various implementations (sphinx, python, javascript, etc.). In this specific case, we actually are, I think (with the exception of the force flag), the full directive docs for mystmd are here (the example is different):
https://mystmd.org/guide/directives#directive-code

Hope that helps @micimize! There are certainly other places where there are inconsistencies between these implementation and documentation. We are continually trying to improve it, so if you see something, please let us know! :)

@micimize
Copy link
Author

@rowanc1 thanks, that makes sense! Sorry, I overloaded this issue but my primary question was what I should now use for parse_myst_to_html for a use-case like display(HTML(parse_myst_to_html(markdown)))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants