mystmd v0.1.15 - February 18th, 2023

Release Source

Overview¶

Help us spread the word 🐦.

There were improvements to role/directive parsing in executablebooks/mystjs#181, this resulted in many new packages that can be used independently in other contexts such as the theme or jupyterlab-myst. The API and links were migrated to myst-tools.org domain for API requests, our new domain! There were improvements for compatibility for admonitions that now parse callouts in Quarto, GitHub, and MyST. You can now embed notebook cells directly into your document, see the documentation.

There were improvements to the docs -- thank you to @kolibril13 and @Carreau who made their first commits.

MyST can now read LaTeX, and parsing was improved wit features to support other types of images (PDF, EPS).

New Features¶

• 📤 Support embedded cross references and output images/text in file exports by @fwkoch in executablebooks/mystjs#154

• 🛏 Embed notebook cells in a page by @fwkoch in executablebooks/mystjs#143

• ❤️ Improve admonitions to support GitHub and Quarto by @rowanc1 in executablebooks/mystjs#229

New Packages¶

We have introduced new extensions for cards, grids and tabs.

• myst-ext-card: Card directives

• myst-ext-grid: Grid directives

• myst-ext-tabs: Tab directives

Commits:

• 📦 Pull tab/grid/card directives into external packages by @fwkoch in executablebooks/mystjs#179

We have pulled out the roles and directives into their own packages. See executablebooks/mystjs#181.

• markdown-it-myst markdown-it plugin to handle tokenizing roles and directives.

• myst-directives core directives for MyST

• myst-roles core roles for MyST

• myst-parser converts markdown-it token stream to mdast

• myst-to-html convert MyST to HTML

Commits:

• 💥 Role / Directive Refactor by @fwkoch in executablebooks/mystjs#184

Documentation Improvements¶

• 📖 Document JATS exports by @rowanc1 in executablebooks/mystjs#109

• 📖 Improve the quickstart tutorials by @rowanc1 in executablebooks/mystjs#152

• 📖 Fix readme example, mystjs undefined use MyST directly. by @Carreau in executablebooks/mystjs#159

• 📖 Improve logging of LaTeX error messages by @rowanc1 in executablebooks/mystjs#165

• 📖 Issue templates for .github by @rowanc1 in executablebooks/mystjs#171

• 📖 Improve onboarding documentation by @rowanc1 in executablebooks/mystjs#214

• 📖 Improve quickstart with warnings by @rowanc1 in executablebooks/mystjs#218

• 📖 🗂 Document tab behavior by @rowanc1 in executablebooks/mystjs#132

• 📖 Overhaul Docs and many details by @rowanc1 in executablebooks/mystjs#146

• 📖 📚 Document notebook cell labels and separate site/project configs by @fwkoch in executablebooks/mystjs#177

• 📖 🔗 Update domain to myst-tools for all links. by @rowanc1 in executablebooks/mystjs#182

• 📖 Small tweaks in the quickstart guide by @kolibril13 in executablebooks/mystjs#215

New LaTeX Parsing and Features¶

See the blog post by Curvenote.

The entire LaTeX rendering process can run in a few hundred milliseconds from start to finish rather than around 3-10 seconds for small documents using common LaTeX renderers. The paper I was testing on during this blog post is ⚡️ 16 times faster ⚡️ - which is significant, and there is lots of room for improvement in MyST as well!

• ⚡️ Introduce a latex parser/converter by @rowanc1 in executablebooks/mystjs#110

• ⚡️ Improve latex parsing by @rowanc1 in executablebooks/mystjs#117

• 🎆 Use unix path for images in latex by @fwkoch in executablebooks/mystjs#125

• 📄 Render include node children during tex/docx export by @fwkoch in executablebooks/mystjs#163

• 🎇 Support for PDF images by @rowanc1 in executablebooks/mystjs#173

• 🎆 Update image conversion transform to handle EPS images by @fwkoch in executablebooks/mystjs#228

Usability improvements¶

• 🌎 Publish source file and exports by @fwkoch in executablebooks/mystjs#112

• 📑 Define exports as a single string by @rowanc1 in executablebooks/mystjs#148

• 📤 Implicitly initialize project to resolve single file export cross references by @fwkoch in executablebooks/mystjs#167

• 💥 Reload project on toc change, new bib files by @fwkoch in executablebooks/mystjs#175

• 🔄 Reload project on all created/deleted files during watch by @fwkoch in executablebooks/mystjs#186

• 📤 Get text output working in exports by @fwkoch in executablebooks/mystjs#176

• 💬 Add comment to default html-to-mdast handlers by @fwkoch in executablebooks/mystjs#205

• 🆕 Add mystToHtml as a simple wrapper function by @rowanc1 in executablebooks/mystjs#234

• 🤺 Do not parse nested colon fence as directive option by @fwkoch in executablebooks/mystjs#227

• ◻️ Allow whitespace around role name inside brackets by @fwkoch in executablebooks/mystjs#233

Refactoring¶

• 🔀 Move References/Footnotes/Citations types to myst-common by @fwkoch in executablebooks/mystjs#108

• 🔄 Move template enums from myst-templates to myst-common by @fwkoch in executablebooks/mystjs#111

• 🔄 Improve myst-frontmatter by @rowanc1 in executablebooks/mystjs#119

• 📗 Update notebook handling to use new nbtx by @fwkoch in executablebooks/mystjs#133

Bug Fixes¶

• 🐛 Path replacement on windows for logging by @rowanc1 in executablebooks/mystjs#116

• 🐛 LaTeX: Capture framed environment by @rowanc1 in executablebooks/mystjs#123

• 🐛 Shell output capture for windows by @rowanc1 in executablebooks/mystjs#124

• 🐛 Target propagations after lifting mystDirectives by @rowanc1 in executablebooks/mystjs#136

• 🐛 Catch and mute spurious warnings by @rowanc1 in executablebooks/mystjs#145

• 🐛 Change reloadConfigs --> reload by @rowanc1 in executablebooks/mystjs#147

• 🐛 Show yaml errors for jtex and allow myst: v1 by @rowanc1 in executablebooks/mystjs#151

• 🐛 Validate subtitle & short_title on project/site by @rowanc1 in executablebooks/mystjs#174

• 🐛 Fix packaging for downstream theme components by @rowanc1 in executablebooks/mystjs#178

• 🐛 Delete children rather than set to undefined by @rowanc1 in executablebooks/mystjs#232

• 🐛 Fix/whitespace option by @fwkoch in executablebooks/mystjs#226

New Contributors¶

• @Carreau made their first contribution in executablebooks/mystjs#159

• @kolibril13 made their first contribution in executablebooks/mystjs#215

Full Changelog: https://github.com/executablebooks/mystjs/commits/myst-cli@0.1.15