search

jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
219 stars 64 forks source link

🎁 Use `commonDirectiveOptions` in all directives #1650

Closed agoose77 closed 4 days ago

agoose77 commented 6 days ago

This PR tackles #1657. We will need an upstream myst-theme PR to ensure that these are actually set in the DOM.

I omitted the documentation directives {myst:role} et al. I didn't think they needed it.

changeset-bot[bot] commented 6 days ago

🦋 Changeset detected

Latest commit: 826df5b22e519e417aef2ca53c7a47e4d7a3478d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages | Name | Type | | ----------------- | ----- | | myst-ext-exercise | Patch | | myst-directives | Patch | | myst-ext-proof | Patch | | myst-ext-grid | Patch | | myst-ext-tabs | Patch | | myst-parser | Patch | | myst-roles | Patch | | myst-to-html | Patch | | myst-transforms | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

agoose77 commented 5 days ago

@fwkoch can you help clarify the changeset semver policy? I'm not clear for mystmd when we can make a minor bump.

agoose77 commented 5 days ago

Requires https://github.com/jupyter-book/myst-theme/pull/500 to see some of the improvements.

fwkoch commented 5 days ago

I put my thoughts about the semver policy here: https://github.com/jupyter-book/mystmd/pull/1658 - nothing official in that yet, just my opinions!

agoose77 commented 5 days ago

Yes @fwkoch, and helpful of you to explicitly surface that change --I made the same judgment that it feels like we should be able to identify and reference most (all) directives, but that isn't a small conceptual change by any means.

agoose77 commented 4 days ago

@fwkoch thanks for your review! Really good catch on the enumerated - nonumber overlap! I've updated the directives to prefer nonumber to enumerated, but respect the latter if given.

I've also reworked the docs to use {myst} or tabs for pairing syntax and rendered examples. I removed reference to sphinx-exercise, because at this point we are unifying things in a breaking manner, and we're trying to distance ourselves from the notion that MyST is 100% compatible with Sphinx.

If you are OK with these changes, please merge the PR!

fwkoch commented 4 days ago

The last thing I did was add commonDirectiveOptions to solution directive. I think that makes sense - you can now have, for example, Solution 1 and Solution 2 which may both be solutions to Exercise 1.

agoose77 commented 4 days ago

@fwkoch thank you for catching those mistakes. Fab.