executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
714 stars 191 forks source link

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

Open micimize opened 4 months ago

micimize commented 4 months ago

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)))

welcome[bot] commented 4 months ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
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! :tada:

micimize commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

@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)))