We’ve just released mystmd 1.11.0 and myst-theme 1.4.1! Here are some of the bigger improvements and fixes that we made.
For authors¶
Stable links to notebook cells. Links to a notebook cell (like
page#cell-id) used to change on every build. MyST now uses each cell’s notebook ID as its anchor, and the theme supports Jupyter-style#cell-id=<id>links, so links to cells keep working across builds.Grid layouts inside figures. You can now put a
{grid}inside a{figure}for responsive multi-image layouts, like one column on narrow screens and two on wide ones.Fewer surprise DOI citations. MyST used to turn any link that ended in a DOI into a citation. Now, only
doi.orglinks are converted, along with raw DOIs anddoi:links. To keep the old behavior, setinfer_dois_from_urls: true.Execution cache stored as notebooks. MyST now stores cached execution outputs as
.ipynbfiles. If you’re debugging a build, you can inspect cached outputs with any notebook viewer. Existing caches still work.Serve
myst starton your network. We’ve documented how to run the MyST server on a custom host address, for example from a container or a remote machine.Bug fixes. Figures made from captioned notebook cells show their images again (this broke in mystmd 1.7.0). Multi-word glossary terms no longer break Typst PDF export. On Windows, notebooks now execute from their own folder, so relative file paths work.
For developers building on MyST¶
These changes are for people building themes, templates, or other tools on top of MyST. They don’t change anything for authors yet.
A new HTML rendering pathway for themes. A theme can now declare its own render command for
myst build --html. If it does,mystmdruns that command instead of starting a server and crawling every page, so a theme could use a static site generator approach.A manifest of public files. Site builds now include a
public.jsonfile that lists the files underpublic/, so themes can build static sites without file-system access to the site content.New developer documentation. We added a guide to the MyST AST structure and metadata and documented how a plugin can aggregate information across multiple pages, like a site-wide glossary.
Changelogs¶
You can also read about this release at jupyterbook
Upgrade notes¶
To upgrade
mystmd:npm install -g mystmd(orpip install -U mystmd)To upgrade
myst-theme: Delete_build; it will be downloaded again during the next build.
Try it out!¶
We’d love your feedback! Try the new release and let us know what works well and where we can improve.
Thank you contributors!¶
This release would not have been possible without the help of our community! Thanks to everyone who contributed discussions, ideas, code, and review across this release: @agoose77, @bsipocz, @choldgraf, @ciyer, @coretl, @Darshan808, @DobbiKov, @dylanpulver, @FernandoBasso, @fperez, @FreekPols, @fwkoch, @humitos, @jasongrout, @JimMadge, @Jorge-Polanco-Roque, @KirstieJane, @kmuehlbauer, @krassowski, @mfisher87, @Montanajim, @nocomplexity, @parmentelat, @rowanc1, @sbonaretti, @sinclairtarget, @stefanv, @stevejpurves, and @TimMonko.