Git Product home page Git Product logo

Comments (4)

welcome avatar welcome commented on June 19, 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! 🎉

from myst-parser.

micimize avatar micimize commented on June 19, 2024

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?

from myst-parser.

rowanc1 avatar rowanc1 commented on June 19, 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! :)

from myst-parser.

micimize avatar micimize commented on June 19, 2024

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

from myst-parser.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.