MyST Document Engine Releases

Release notes for the MyST Document Engine (mystmd).

mystmd@1.8.0¶

2026-01-21 | View release

This brings in new functionality for execution concurrency, allowing you to control how many notebooks are executed in parallel during build in case you have notebooks that depend on one another or spin up their own parallel kernele. Also added a number of stability improvements and quality of life features.

Enhancements made

• Allow users to define the number of simultaneous executions #2428 (agahkarakuzu, agoose77, bsipocz, choldgraf, stefanv)

• Add CLI to generate ReadTheDocs configuration via myst init --readthedocs #2555 (jtpio, choldgraf, mfisher87)

• Allow the API URL to be configured with an environment variable #2554 (parmentelat, agoose77)

• 🔐 Use npm ci instead of npm install for theme dependencies #2487 (stefanv, agoose77, mfisher87, stevejpurves)

• Update @preview/subpar for subfigures in typst export #2624 (jan-david-fischbach, rowanc1)

Bugs fixed

• Define edit_url as page and project frontmatter #2650 (choldgraf, agoose77, rowanc1, stefanv)

• Improve edit URL branch logic #2642 (choldgraf, agoose77, rowanc1, stefanv)

• β Remove ‘ß’ mapping from utils #2639 (rowanc1, choldgraf)

• Allow TOC to set short_title #2636 (choldgraf, bsipocz, stefanv)

• FIX: formatting in developer.md for mermaid diagram #2619 (jan-david-fischbach, rowanc1)

• Add support for parsing decimal numbers in si role #2600 (jan-david-fischbach, rowanc1)

• Fix empty button role #2557 (choldgraf, agoose77, stefanv)

Maintenance and upkeep improvements

• Add repository information for myst-transforms #2664 (choldgraf)

• ⛘ Bring myst-spec into monorepo for further development #2584 (rowanc1, Carreau, aktech, boisgera, choldgraf, chrisjsewell, fwkoch, sglyon)

Documentation improvements

• Add pointer to MEP repo. #2588 (ryanlovett, agoose77)

• Add citation markdown formatting info to simple referencing with DOI Link #2651 (TimMonko, choldgraf)

• Minor spelling fix #2645 (tylere, choldgraf, stefanv)

• 📖 Clarify that subtitle is also available in project configuration #2633 (lucafrance, rowanc1)

• Fix link #2632 (lucafrance, agoose77)

• an extra ‘The file’ forgotten at the end of line #2611 (parmentelat, agoose77)

• docs: update primary sidebar footer #2604 (jnywong, choldgraf)

• Clarify download documentation #2597 (choldgraf)

• DOC: removing deprecated frontmatter from docs #2596 (bsipocz, agoose77, choldgraf)

• fix typo in documentation of options #2587 (brownsarahm, rowanc1)

• Add a description of the theme server contract #2566 (akhmerov, agoose77, choldgraf, rowanc1)

• revisited doc on table of contents #2522 (parmentelat, bsipocz, choldgraf)

• Update documentation on extends #2362 (FreekPols, choldgraf, stefanv)

mystmd@1.7.1¶

2025-12-10 | View release

(full changelog)

Enhancements made

• ☑️ MyST-to-TeX: add support for checkboxes #2560 (nthiery, rowanc1)

• 🚛 migrate xrefs #2551 (stevejpurves, fwkoch, rowanc1, stefanv)

• ⏪ Support sort: ascending order on patterns in the table of contents #2546 (rowanc1, agoose77, choldgraf, mfisher87, stefanv)

• 💰 Dollarmath settings for markdown parsing #2542 (rowanc1)

Bugs fixed

• 🔑 Add key to avoid react error #2577 (rowanc1)

• 🐛 Catch error states of chokidar #2543 (rowanc1)

• 🛑 Kill process trees on Linux #2529 (rowanc1, akhmerov)

Maintenance and upkeep improvements

• 📦 Generalize the HTTP logger for the myst-cli #2574 (rowanc1)

• 🧪 Remove short DOI test in latex #2572 (rowanc1)

• 📦 Remove any in container #2571 (rowanc1)

• 👮 Type check and type alignment #2561 (stevejpurves, rowanc1)

Documentation improvements

• Remove a confusing clarification #2564 (akhmerov, choldgraf)

• Improve documentation on making releases #2157 (choldgraf)

mystmd@1.7.0¶

2025-12-04 | View release

(full changelog)

Enhancements made

• 🤖 Update our TS config and bundler versions #2499 (agoose77, rowanc1, changeset-bot)

• 🤖 Store execution outputs in Outputs #1903 (agoose77, stevejpurves, rowanc1, changeset-bot, fwkoch, stefanv)

Bugs fixed

• 🐛 Latex tables without containers #2536 (rowanc1, changeset-bot, stefanv)

• 🐛 Do not raise errors on non-accessible sub-trees #2532 (rowanc1, choldgraf, changeset-bot)

Maintenance and upkeep improvements

• 🐛 Incorrect type import #2541 (rowanc1, changeset-bot)

• 📦 Packaging updates #2539 (rowanc1, changeset-bot)

• Add npm verb to quickly demo docs #2516 (choldgraf, rowanc1, changeset-bot)

Documentation improvements

• 📖 Fix typo in GitHub Pages documentation #2550 (asjohnston-asf, rowanc1, stefanv, changeset-bot)

• 📖 Deploy all docs in automation #2528 (rowanc1, changeset-bot)

• 📖 Enhance deployment.md with BASE_URL examples #2510 (FreekPols, rowanc1, akhmerov, changeset-bot)

• Advice on how to grep myst codebase #2488 (stefanv, rowanc1, changeset-bot)

mystmd@1.6.7¶

2025-12-01 | View release

(full changelog)

Enhancements made

• 🔑 Support keys for DOI links #2492 (rowanc1, mfisher87, stefanv, changeset-bot)

• Add support for notebook cell output scroll metadata #2433 (choldgraf, agoose77, changeset-bot, bsipocz)

Bugs fixed

• 🐛 Footnote and role parsing bug #2525 (rowanc1, changeset-bot)

• 🐛 Don’t crash if links don’t have URLs #2518 (rowanc1, changeset-bot)

• 🗺️ Fetch sitemap when building static site #2450 (agoose77, changeset-bot)

• 🧹 Remove hide_authors handling #2420 (agoose77, choldgraf, stefanv, changeset-bot)

Maintenance and upkeep improvements

• 📖 Trigger docs build with release workflow #2519 (choldgraf, rowanc1, changeset-bot)

Documentation improvements

• slight improvements in docs on configuration / frontmatter #2521 (parmentelat, choldgraf, changeset-bot)

• 📖 Make the myst-transform doc smoother and more legible #2520 (parmentelat, rowanc1, changeset-bot)

• Add plugin use case and debugging docs #2515 (mfisher87, choldgraf, changeset-bot)

• Add documentation to {myst} directive #2508 (mfisher87, agoose77, changeset-bot)

• Provide explicit debug command in error rules documentation #2494 (mfisher87, stefanv, changeset-bot)

• 📖 Add subsection about document titles in TOC #2484 (rossbar, rowanc1, stefanv, changeset-bot)

• ⚙️ Update webserver deploy documentation #2479 (akhmerov, agoose77, changeset-bot)

• Update site options docs for clarity #2468 (choldgraf, stefanv, changeset-bot)

• Update OpenAlex API link in frontmatter documentation #2467 (akhmerov, choldgraf, changeset-bot)

• Fix typo #2465 (ofek, choldgraf, changeset-bot)

• Document how to use options with dashes in their names #2463 (stefanv, choldgraf, changeset-bot)

• Update documentation for MyST HTML option #2462 (akhmerov, choldgraf, stefanv, changeset-bot)

Other merged PRs

• chore: add changeset #2513 (agoose77, changeset-bot, stefanv, rowanc1)

mystmd@1.6.6¶

2025-11-19 | View release

(full changelog)

Bugs fixed

• Fix execution bug: no need for kernelspec if no executable content #2454 (choldgraf, stefanv, changeset-bot)

Other merged PRs

• Pull in latest myst-execute #2456 (stefanv, changeset-bot)

mystmd@1.6.5¶

2025-11-18 | View release

(full changelog)

Enhancements made

• 🖼️ Add support for iframe title. #2437 (ryanlovett, agoose77, stefanv, stevejpurves, choldgraf)

• 🧪 Add mhchem extension #2418 (rowanc1, agoose77)

• 🚢 Enable port option for the builder #2409 (agahkarakuzu, fwkoch)

• 🪧 Add message for using Jupyter Book < 1 to upgrade #2390 (choldgraf, rowanc1)

• ✊ Add environment dependence for cache keys (etc.) to myst build --execute #2387 (agoose77, bsipocz, choldgraf, rowanc1)

Bugs fixed

• 🔠 Always set term label from {term} #2346 (agoose77, fwkoch, rowanc1)

Maintenance and upkeep improvements

• 🤖 Stop over-eager documentation labeling #2417 (fwkoch, stefanv)

• 🧪 Add node 24 to ci testing #2410 (fwkoch, agoose77)

Documentation improvements

• 📚 Adjust external xref docs #2412 (fwkoch, agoose77)

• Update the plugins admonition to be a little more nuanced #2403 (choldgraf, agoose77)

• 📖 Add a link to the numbered citations #2402 (rowanc1, matthewfeickert)

• Doc exec build improved #2396 (parmentelat, choldgraf, stefanv)

• :blue_book: Document static theme development #2309 (brianhawthorne, stefanv, choldgraf)

• Make settings configuration more discoverable #2237 (choldgraf, bsipocz, agoose77)

mystmd@1.6.4¶

2025-11-03 | View release

(full changelog)

Enhancements made

• ⚠️ Improve {doc} role warning with node position #2375 (rowanc1, changeset-bot, mfisher87)

• 🐛 Log errors on watch #2355 (rowanc1, changeset-bot)

Bugs fixed

• 🪟 Windows-path for toc #2389 (rowanc1, agoose77, fwkoch, changeset-bot)

• 🖼️ Ensure favicon is under site.options #2359 (rowanc1, changeset-bot)

• 🐛 Undefined URLs can cause errors #2356 (rowanc1, changeset-bot)

• 🛠️ Bring MarkdownIt version consistently in-line internally #2323 (agoose77, rowanc1, changeset-bot)

• 🔗 Resolve links and image paths relative to project root if they starts with / #2217 (fk128, fwkoch, changeset-bot, agoose77, mfisher87, rowanc1)

Maintenance and upkeep improvements

• 🪜 Unescape yaml for labeler action #2349 (agoose77, changeset-bot, rowanc1)

Documentation improvements

• Add executable Python examples for navigating and scraping MyST sites #2378 (choldgraf, stefanv, changeset-bot)

• 📖 Formatting bug in docs, and improve admonition page #2358 (rowanc1, changeset-bot)

• 🐛 Caption does not exist on list-table #2357 (rowanc1, changeset-bot)

mystmd@1.6.3¶

2025-10-10 | View release

(full changelog)

Enhancements made

• 🔎 Set HOST environment variable to 127.0.0.1 on ReadTheDocs CI #2313 (rowanc1, changeset-bot)

• 🧮 Allow math in numbering as an alias for equation #2311 (rowanc1, changeset-bot)

Bugs fixed

• 🐛 Include index page in --strict mode error checking #2331 (rowanc1, changeset-bot, bsipocz)

• ✍️ Improvements for typst exports #2330 (fwkoch, rowanc1, changeset-bot)

• 🤐 Show an error when the myst.xref.json fails to load #2329 (rowanc1, changeset-bot)

• 🔑 Add --keep-host to build command #2305 (rowanc1, changeset-bot)

Maintenance and upkeep improvements

• 📦 tex-to-typst v0.0.18 #2339 (fwkoch, changeset-bot)

• 🏷️ Add autolabeler rules #2326 (agoose77, changeset-bot, bsipocz)

• 📦 Updates to build packages (typescript, esbuild, vite, nanoid) #2314 (rowanc1, changeset-bot)

• 📦 Update @jupyterlab/services lockfile pin #2297 (agoose77, rowanc1, bsipocz, changeset-bot)

• :wrench: Refactorings to clean up table-of-contents transform #2181 (brianhawthorne, fwkoch, changeset-bot)

Documentation improvements

• 📖 xref directives syntax on directives list page #2337 (bsipocz, fwkoch, changeset-bot)

• 📖 Adding xref error rules in cli docs #2335 (bsipocz, rowanc1, changeset-bot)

• 🔗 Ignore patterns for links #2334 (rowanc1, fwkoch, changeset-bot)

• 📖 Add default severity for RuleIds to the docs #2333 (rowanc1, fwkoch, bsipocz, changeset-bot)

• 📖 Document error rules #2332 (rowanc1, changeset-bot)

• 🗓️ Add quotes for dates #2324 (bsipocz, agoose77, changeset-bot)

mystmd@1.6.2¶

2025-09-28 | View release

(full changelog)

Enhancements made

• 📄 Add toc node to render table of contents in Typst and LaTeX #2266 (joequant, rowanc1, changeset-bot)

• 🐪 Enable alternate YAML build config #2219 (brianhawthorne, fwkoch, rowanc1, changeset-bot, stefanv)

Bugs fixed

• 🔐 Improve security for localhost #2281 (rowanc1, changeset-bot)

• 🔧 Ensure hidden pages are built for HTML exports #2194 (fwkoch, choldgraf, parmentelat, stefanv, changeset-bot, mfisher87)

Documentation improvements

• 📄 Micro typos and tweaks in developer.md #2292 (parmentelat, rowanc1, changeset-bot)

• DOC: Adding yaml example as the page was a bit confusing #2285 (bsipocz, choldgraf, stefanv, changeset-bot)

• 📖 Landing page TOC title #2212 (bsipocz, rowanc1, changeset-bot)

• 📄 Document disable MyST branding feature #2104 (artoftheblue, rowanc1, changeset-bot)

mystmd@1.6.1¶

2025-09-08 | View release

(full changelog)

Enhancements made

• 🐦 Change social link from Twitter to BlueSky #2216 (agoose77, rowanc1, changeset-bot)

• 🚸 Take users directly to the GitHub editing interface when clicking “Edit this page” #2138 (mfisher87, fwkoch, choldgraf, rowanc1, changeset-bot, agoose77)

Bugs fixed

• 🐛 Add Typst PDF to the MECA bundle #2274 (rowanc1, changeset-bot)

• 🐛 List elements with citeGroups as children #2261 (rowanc1, changeset-bot)

• 🐛 List elements with footnoteReferences as children #2256 (rowanc1, changeset-bot)

• 🐛 Typst option on inlineMath node #2242 (rowanc1)

• 🐛 mdast lists need to be in paragraphs #2241 (rowanc1, fwkoch, changeset-bot, agoose77)

• ↖️ Ensure project config loads before site #2184 (agoose77, fwkoch, changeset-bot)

Maintenance and upkeep improvements

• 🔄 Refactor admonition parsing to expose header function #2244 (rowanc1, changeset-bot)

• 🔄 Refactor myst-parse to expose parsing options #2243 (rowanc1, changeset-bot)

• Clean up title and fix tag name in CI/CD #2193 (choldgraf, changeset-bot)

• Attach release to pre-existing tag #2191 (choldgraf, changeset-bot)

• Add access token to github-activity action #2190 (choldgraf, stefanv, changeset-bot)

• Fix github-activity invocation in CI/CD #2189 (choldgraf, changeset-bot)

• Automate GitHub releases and notes in our ci/cd #2188 (choldgraf, stefanv, changeset-bot)

Documentation improvements

• Add note about using KaTeX in default themes. #2262 (choldgraf, changeset-bot)

• 📖 Fix typo in frontmatter.md for CC-BY-NC-SA license #2246 (kevinlin1, rowanc1, changeset-bot)

• 📖 Typo in docs formatting #2240 (rowanc1, changeset-bot)

• 📖 Add pronunciation of MyST #2238 (choldgraf, rowanc1, bsipocz, changeset-bot, agoose77)

• 📖 Add documentation for running test suite #2226 (choldgraf, rowanc1, changeset-bot)

• 📖 Swapping out python references to an up-to-date version #2210 (bsipocz, rowanc1, changeset-bot)

• DOC: Adding upgrade guide link #2206 (bsipocz, choldgraf, changeset-bot, rowanc1)

Other merged PRs

• Remove explicit target for tag #2192 (choldgraf, changeset-bot)