v0.1.15

Overview

Help us spread the word 🐦.

There were improvements to role/directive parsing in #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 #154
• 🛏 Embed notebook cells in a page by @fwkoch in #143
• ❤️ Improve admonitions to support GitHub and Quarto by @rowanc1 in #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 #179

We have pulled out the roles and directives into their own packages. See #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 #184

Documentation Improvements

• 📖 Document JATS exports by @rowanc1 in #109
• 📖 Improve the quickstart tutorials by @rowanc1 in #152
• 📖 Fix readme example, mystjs undefined use MyST directly. by @Carreau in #159
• 📖 Improve logging of LaTeX error messages by @rowanc1 in #165
• 📖 Issue templates for .github by @rowanc1 in #171
• 📖 Improve onboarding documentation by @rowanc1 in #214
• 📖 Improve quickstart with warnings by @rowanc1 in #218
• 📖 🗂 Document tab behavior by @rowanc1 in #132
• 📖 Overhaul Docs and many details by @rowanc1 in #146
• 📖 📚 Document notebook cell labels and separate site/project configs by @fwkoch in #177
• 📖 🔗 Update domain to myst-tools for all links. by @rowanc1 in #182
• 📖 Small tweaks in the quickstart guide by @kolibril13 in #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 #110
• ⚡️ Improve latex parsing by @rowanc1 in #117
• 🎆 Use unix path for images in latex by @fwkoch in #125
• 📄 Render include node children during tex/docx export by @fwkoch in #163
• 🎇 Support for PDF images by @rowanc1 in #173
• 🎆 Update image conversion transform to handle EPS images by @fwkoch in #228

Usability improvements

• 🌎 Publish source file and exports by @fwkoch in #112
• 📑 Define exports as a single string by @rowanc1 in #148
• 📤 Implicitly initialize project to resolve single file export cross references by @fwkoch in #167
• 💥 Reload project on toc change, new bib files by @fwkoch in #175
• 🔄 Reload project on all created/deleted files during watch by @fwkoch in #186
• 📤 Get text output working in exports by @fwkoch in #176
• 💬 Add comment to default html-to-mdast handlers by @fwkoch in #205
• 🆕 Add mystToHtml as a simple wrapper function by @rowanc1 in #234
• 🤺 Do not parse nested colon fence as directive option by @fwkoch in #227
• ◻️ Allow whitespace around role name inside brackets by @fwkoch in #233

Refactoring

• 🔀 Move References/Footnotes/Citations types to myst-common by @fwkoch in #108
• 🔄 Move template enums from myst-templates to myst-common by @fwkoch in #111
• 🔄 Improve myst-frontmatter by @rowanc1 in #119
• 📗 Update notebook handling to use new nbtx by @fwkoch in #133

Bug Fixes

• 🐛 Path replacement on windows for logging by @rowanc1 in #116
• 🐛 LaTeX: Capture framed environment by @rowanc1 in #123
• 🐛 Shell output capture for windows by @rowanc1 in #124
• 🐛 Target propagations after lifting mystDirectives by @rowanc1 in #136
• 🐛 Catch and mute spurious warnings by @rowanc1 in #145
• 🐛 Change reloadConfigs --> reload by @rowanc1 in #147
• 🐛 Show yaml errors for jtex and allow myst: v1 by @rowanc1 in #151
• 🐛 Validate subtitle & short_title on project/site by @rowanc1 in #174
• 🐛 Fix packaging for downstream theme components by @rowanc1 in #178
• 🐛 Delete children rather than set to undefined by @rowanc1 in #232
• 🐛 Fix/whitespace option by @fwkoch in #226

New Contributors

• @Carreau made their first contribution in #159
• @kolibril13 made their first contribution in #215

Full Changelog: https://github.com/executablebooks/mystjs/commits/[email protected]

v0.1.0

What's Changed

• Curvenote --> MyST 🎉 by @rowanc1 in #64
• 📖 Update install instructions by @rowanc1 in #65
• 📖⚙️ Update settings and links for internal docs by @rowanc1 in #66
• Use jtex to validate docx templates by @fwkoch in #67
• 👩‍🔬 Update lib in tsconfig by @rowanc1 in #68
• 🐛 Incorrect session URL used in jtex by @rowanc1 in #69
• 🐛 Remove dependence on @curvenote/schema by @rowanc1 in #70
• Include a bundle for mystjs that works with jest by @rowanc1 in #71
• Add github code-file link previews by @rowanc1 in #73
• 📦 Deprecate unified exports from mystjs by @rowanc1 in #74
• 💇‍♀️ Modify extractPart: no longer support tags by @rowanc1 in #76
• 🐛 Relative paths should be '.' if the same by @rowanc1 in #77
• ⏲ Await writeDocx during docx export by @fwkoch in #79
• 🔙 Bring back myst.min.js for unpackage by @rowanc1 in #78
• ✈️ Lift equations out of paragraphs by @rowanc1 in #81
• 🐛 Ensure GitHub link parse is safe w/o protocol by @rowanc1 in #83
• 👩‍🔬 Initial JATS implementation for body content by @rowanc1 in #86
• 🌠 Add transform to CLI to convert svg/gif images to png on export by @fwkoch in #85
• 🎇 Improve fallback when inkscape is not available by @rowanc1 in #88
• 🗃 Allow template.yml#files to be nested by @fwkoch in #89
• 🤫 Allow toText to take a null by @rowanc1 in #91
• 🖇 Move isUrl utility to myst-cli-utils by @rowanc1 in #92
• 🆙 Upgrade doi-utils by @rowanc1 in #94
• 🧙‍♂️ Improve source-maps for development by @rowanc1 in #93
• Library for reading JATS by @rowanc1 in #95
• 🧙‍♂️ Improve JATS from DOI lookup by @rowanc1 in #96
• 👩‍🔬 Update export conversions for latex by @rowanc1 in #102
• 🚀 jats-to-myst by @rowanc1 in #103
• 🌎 Prepare for site templating by @fwkoch in #99
• 📒 Support basic callouts that use *.qmd syntax by @rowanc1 in #106

New Contributors

• @williamstein made their first contribution in #50

Full Changelog: https://github.com/executablebooks/mystjs/commits/[email protected]