[email protected]

(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)
• 🔧 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)

Other merged PRs

• 🚀 Release #2306 (@fwkoch)
• 🚀 Release #2280 (@fwkoch)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@agoose77 (activity) | @brianhawthorne (activity) | @bsipocz (activity) | @changeset-bot (activity) | @fwkoch (activity) | @JimMadge (activity) | @rowanc1 (activity) | @stefanv (activity) | @stevejpurves (activity)

[email protected]

(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)

Other merged PRs

• 🚀 Release #2280 (@fwkoch)
• 🚀 Release #2275 (@rowanc1)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@artoftheblue (activity) | @brianhawthorne (activity) | @bsipocz (activity) | @changeset-bot (activity) | @choldgraf (activity) | @dailyherold (activity) | @fwkoch (activity) | @joequant (activity) | @mfisher87 (activity) | @parmentelat (activity) | @rowanc1 (activity) | @stefanv (activity)

[email protected]

(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)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@agoose77 (activity) | @bsipocz (activity) | @changeset-bot (activity) | @choldgraf (activity) | @ebolyen (activity) | @fwkoch (activity) | @JimMadge (activity) | @kevinlin1 (activity) | @mfisher87 (activity) | @parmentelat (activity) | @rowanc1 (activity) | @stefanv (activity)

[email protected]

This release updates the way that static HTML files are generated, to follow pagename/index.html structure rather than pagename.html structure. Any hard-coded links to your MyST site that end in .html will break, instead you should simply remove the .html (e.g. folder/page.html -> folder/page). This makes Jupyter Book and MyST more reliable when hosting with Static Site services like ReadTheDocs.

(full changelog)

Enhancements made

• 🎯 Render static HTML pages to expected server path #2178 (@stefanv, @rowanc1, @choldgraf, @bsipocz, @agoose77, @changeset-bot)
• 🔗 Fix URLs in table of contents directive #2140 (@brianhawthorne, @rowanc1, @stefanv, @changeset-bot)

Bugs fixed

• 🏷️ Add NPM binary name to whitelabelling #2175 (@agoose77, @rowanc1, @changeset-bot, @stefanv)
• Add ipynb format option in validators #2159 (@kp992, @agoose77, @changeset-bot)

Maintenance and upkeep improvements

• 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

• 📖 Remove out of date readme note #2155 (@rowanc1, @choldgraf, @changeset-bot)
• 📖 A few miscellaneous documentation updates #2154 (@rowanc1, @changeset-bot)

Other merged PRs

• Remove explicit target for tag #2192 (@choldgraf, @changeset-bot)
• 🚀 Release #2180 (@rowanc1)
• 🚀 Release #2130 (@rowanc1)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@agoose77 (activity) | @brian-rose (activity) | @brianhawthorne (activity) | @bsipocz (activity) | @changeset-bot (activity) | @choldgraf (activity) | @ebolyen (activity) | @kp992 (activity) | @mfisher87 (activity) | @rowanc1 (activity) | @stefanv (activity)

v1.5.1

What's Changed

• ⚠️ Fix warning about .* image extension by @rowanc1 in #2125
• ⨱ Underline in html is parsed correctly by @rowanc1 in #2129
• 📖 Document bibliography in frontmatter by @rowanc1 in #2134
• 📥 Fix embedding raw code with remove-input flag by @agoose77 in #1937
• 🧮 Add a typst option in math nodes by @rowanc1 in #2133
• Document our lightweight development prioritization process by @stefanv in #2121
• Clarify site parts for footers by @choldgraf in #2128
• 👩🏼‍💼 Update OSI Licenses by @agoose77 in #2146
• ➡️ Indentation of log message in crossReference by @agoose77 in #2144
• 📠 Add up/downgrade for outputs AST change by @agoose77 in #1900
• ⏱️ Remove time unit from timing message by @agoose77 in #2153
• 🎬 More whitelabelling for myst init by @agoose77 in #2152
• Update documentation about in-browser execution by @choldgraf in #2110
• 🚀 Release by @github-actions in #2130

Full Changelog: https://github.com/jupyter-book/mystmd/compare/[email protected]@1.5.1

[email protected]

(full changelog)

Enhancements made

• 🗾 HTML Image Width #2111 (@rowanc1, @changeset-bot)
• 👽 Handle external URL specified in TOC #2102 (@stefanv, @fwkoch, @choldgraf, @mfisher87, @rowanc1, @changeset-bot)
• 🫥 Exclude hidden entries from site manifests #2097 (@parmentelat, @fwkoch, @changeset-bot, @stevejpurves)

Bugs fixed

• Update @citation-js/xxx packages #2116 (@agoose77, @changeset-bot, @rowanc1)
• 🧮 Improve inline math symbol replacements #2115 (@rowanc1, @changeset-bot)
• 🩹 Add changeset for myst-frontmatter #2107 (@agoose77, @changeset-bot)
• 🩹 Add missing changeset for simple-validators #2105 (@agoose77, @changeset-bot)

Documentation improvements

• 📝 Add a note about our release processes #2108 (@agoose77, @choldgraf, @rowanc1, @stefanv, @changeset-bot)
• Document plugin packaging and improve plugin docs #2100 (@choldgraf, @stefanv, @agoose77, @changeset-bot)
• Add doc for Apache httpd deployment #2094 (@ktyle, @stefanv, @agoose77, @choldgraf, @changeset-bot)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@agoose77 (activity) | @artoftheblue (activity) | @choldgraf (activity) | @fwkoch (activity) | @ktyle (activity) | @mfisher87 (activity) | @parmentelat (activity) | @rowanc1 (activity) | @stefanv (activity) | @stevejpurves (activity)

mystmd v1.4.0

(full changelog)

Enhancements made

• 💬 Add social media project frontmatter #2021 (@kne42, @agoose77, @fwkoch, @rowanc1, @choldgraf, @artoftheblue)
• Complete ipynb export support #1915 (@kp992, @agoose77)
• 🧮 Improve emphasize-lines to allow for ranges #2048 (@rowanc1)
• 🔄 Change default LaTeX template to plain_latex #2037 (@agoose77)
• ⚠️ Improve error messages for myst templates download command #2034 (@agoose77, @roaldarbol)
• Remove extra error block #2011 (@stefanv, @choldgraf)
• 🕵️‍♀️ Expose hidden attribute in TOC nodes #1993 (@parmentelat, @fwkoch)

Bugs fixed

• 🔌 Load plugins earlier, before parsing frontmatter parts #2093 (@fwkoch, @choldgraf, @stefanv, @agoose77)
• 🔍 Do not treat wiki permalinks as wiki-links for now #1959 (@agoose77, @rowanc1)
• 🐌 Fix slug handling for MyST projects using a ToC #2045 (@agoose77, @rowanc1)

Documentation improvements

• ⌨️ Documentation spelling and example improvements #2083 (@artoftheblue, @agoose77, @choldgraf)
• 📄 Document footer usage #2081 (@stefanv, @choldgraf)
• Add inline expressions links #2076 (@choldgraf, @rowanc1)
• Add a dedicated authorship and affiliations section #2050 (@choldgraf, @agoose77, @rowanc1)
• ⚠️ Remove docs warning on legacy link syntax #2047 (@rowanc1, @choldgraf)
• Document the launch button functionality #2046 (@choldgraf, @agoose77)
• 🧹 Move CONTRIBUTING.md contents to docs #2040 (@agoose77)
• Quick guide to making documentation edits in-browser for our contributor guide #2030 (@choldgraf, @agoose77)
• Document CORS tip #2026 (@choldgraf, @rowanc1)
• Document site.folders option #2025 (@FernandoBasso, @choldgraf)
• Update links to example of landing pages #2016 (@agoose77, @choldgraf, @rowanc1)
• Explain more MyST concepts, developer docs, and export docs #2012 (@choldgraf, @stefanv, @rowanc1)
• Fix typo in md-vs-ipynb.md #2010 (@choldgraf, @rowanc1)
• Document how to put content in the right sidebar area #2004 (@choldgraf, @agoose77)
• 📖 Update documentation on docs contributions #1999 (@choldgraf, @rowanc1)
• 📖 Document light dark elements with CSS classes #1998 (@choldgraf, @rowanc1)
• 📖 Add guidelines for publishing a release to GitHub #1997 (@choldgraf, @rowanc1)
• Update documentation about our documentation infrastructure at mystmd.org #1958 (@choldgraf, @agoose77, @rowanc1, @stefanv, @fperez)

Maintenance and upkeep improvements

• 📦 Bump turbo repo #2091 (@fwkoch, @choldgraf, @agoose77)
• 🤖 Add required label workflow #2053 (@agoose77, @choldgraf)
• 🤖 Deploy Docs in CI #2087 (@rowanc1, @choldgraf)
• ❄️ Update dev flake inputs #2039 (@agoose77)
• ✅ Add husky and lint-staged to help devs fix code before pushing #1919 (@stefanv, @choldgraf, @fwkoch, @agoose77)

Other merged PRs

• 📦 Bump [email protected] #2023 (@fwkoch, @rowanc1, @choldgraf)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See our definition of contributors.

(GitHub contributors page for this release)

@agoose77 (activity) | @artoftheblue (activity) | @choldgraf (activity) | @da5nsy (activity) | @FernandoBasso (activity) | @fperez (activity) | @FreekPols (activity) | @fwkoch (activity) | @kne42 (activity) | @kp992 (activity) | @michaelaye (activity) | @parmentelat (activity) | @roaldarbol (activity) | @rowanc1 (activity) | @stefanv (activity) | @stevejpurves ([activity](https://github.com/search?q=repo%3Ajupyter-book%2Fmystmd+involves%3Astevejpurves+updated%3A2...

v1.3.26

This release brings in major new functionality for extensibility with roles and directives, allowing you to pass classes and arguments to them. It also includes a number of enhancements, bugfixes, and documentation improvements as we prepare the MyST engine for use with Jupyter Book 2. See the features section for more details!

Features

• 🧮 Add inline options to roles and directives by @rowanc1 in #1822.
  • Adds support for inline attributes for both roles and directives, allowing concise specification of CSS classes, IDs, and attributes. This complements other methods for defining options, making markup more expressive and flexible. 👉 Read more here
• 🦋 Add bluesky social links by @rowanc1 in #1987
  • Adds support for several more types of social links for content authors. 👉 Read more here
• 🚀 Update the SPEC_VERSION for block.class by @rowanc1 in #1895
• ⌨️ Add command line argument to myst start for selecting template by @stefanv in #1914
• 📦 Bump nbtx 0.4.0 by @fwkoch in #1897

Fixes

• 🐝 Fix missing class in landing-pages by @agoose77 in #1894
• 🐛 Ensure CSS has baseURL directly by @rowanc1 in #1901
• ✍️ Escape backticks in init --gh-pages template by @agoose77 in #1936
• 🏷️ Remove default label from inlineExpression node by @agoose77 in #1943
• 🐛 Fix missing references in docx export by @alanrice in #1944
• 👨🏻‍🔧 fix check link transform for cards by @stevejpurves in #1945
• ; Semicolon escape in typst by @rowanc1 in #1980
• 🐛 --pdf --> --tex by @rowanc1 in #1995
• 🪄 Improve error handling during cross reference resolution by @agoose77 in #1942
• 🔙 Move execution transform earlier in mdast pipeline by @agoose77 in #1949

Documentation

• 📚 Add a high-level overview of MyST components by @choldgraf in #1950
  • Overview Documentation
• Add a brief guide to choosing between .md and .ipynb by @choldgraf in #1969
  • MD vs IPYNB Documentation
• Restructure developer guide and add architecture overview by @stefanv in #1906
  • Developer Documentation
• DOCS: Clarify and cross-link code cell output suppression by @choldgraf in #1992
• 📦 Improve docs on PDF exports for downloads by @agoose77 in #1966
  • Website Downloads Documentation
• 📚 Clarify BASE_URL instructions in GH action for custom domains. by @fperez in #1930
• Add footnote about links to md files not in ToC by @JimMadge in #1939
• Update the documentation on installing with Typst by @choldgraf in #1941
• 📖 Document how to export MyST Markdown by @choldgraf in #1955

Maintenance

• 📝 Add missing changeset by @agoose77 in #1938
• ✋ netlify: only rebuild docs when they were modified by @stefanv in #1951
• 🚀 Release by @github-actions in #1896

New Contributors

• @fperez made their first contribution in #1930
• @alanrice made their first contribution in #1944

Full Changelog: https://github.com/jupyter-book/mystmd/compare/[email protected]@1.3.26

v1.3.24

What's Changed

• 🐛 Improve error message for missing javascript and python plugins by @JimMadge in #1835
• 🔗 Add citation for the project by @rowanc1 in #1837
• ✍️ Fix typo in Jupyter Book TOC upgrade routine by @agoose77 in #1839
• 🪟 Fix plugin loading on Windows by @agoose77 in #1841
• 📖 Update to installing instructions to include conda by @mmcky in #1840
• 🚫 Add page frontmatter option to disable execution by @agoose77 in #1842
• ⬆️ Add simple upgrade/downgrade package for MyST AST by @agoose77 in #1802
• 📖 Improve Executable Markdown Documentation by @rowanc1 in #1852
• 📖 Remove warnings by @rowanc1 in #1853
• 🔧 Fix errors about missing images on non-first builds by @fwkoch in #1856
• 📂 Set site.options.folders: true for JB upgrades by @agoose77 in #1867
• Handle unsupported options for include directive by @JimMadge in #1872
• 💇 Add documentation on site.options.style by @agoose77 in #1873
• ✏️ Use myst directive with proof option definitions by @agoose77 in #1881
• ✨ New table of contents directive by @fwkoch in #1826
• 🚀 Release by @github-actions in #1836

New Contributors

• @JimMadge made their first contribution in #1835
• @mmcky made their first contribution in #1840

Full Changelog: https://github.com/jupyter-book/mystmd/compare/[email protected]@1.3.24

v1.3.23

What's Changed

• 💬 Preserve quotes in inline expressions upon request by @agoose77 in #1812
• 🖲 Add button role by @jnywong in #1773
• 🌎 Remove TLD of .java and .zip from linkify by @rowanc1 in #1825
• 📌 Update docs about grid breakpoints to reflect changes in theme by @agoose77 in #1819
• 🐛 Fix unwanted continuous numbering for some enumerated types by @fwkoch in #1824
• 📖 Improve documentation around export config in the myst.yml by @rowanc1 in #1807
• 🚀 Release by @github-actions in #1815

New Contributors

• @jnywong made their first contribution in #1773

Full Changelog: https://github.com/jupyter-book/mystmd/compare/[email protected]@1.3.23