Changelog

0.13.1 - 2020-12-31

👌 Directives can now be used for inline substitutions, e.g.

---
substitutions:
  key: |
    ```{image} img/fun-fish.png
    :alt: fishy
    :height: 20px
    ```
---

An inline image: {{ key }}

0.13.0 - 2020-12-18

This release makes some major updates to the optional syntaxes. For full details see Optional MyST Syntaxes.

🗑 Deprecations

myst_enable_extensions = ["dollarmath", ...] now replaces and deprecates individual enable configuration variables: admonition_enable -> "colon_fence", figure_enable -> "colon_fence", dmath_enable -> "dollarmath", amsmath -> "colon_fence", deflist_enable -> "deflist", html_img_enable -> "html_image".

The colon_fence extension (replacing admonition_enable) now works exactly the same as normal ``` code fences, but using ::: delimiters. This is helpful for directives that contain Markdown text, for example:

:::{admonition} The title
:class: note

This note contains *Markdown*
:::

✨ New

The smartquotes extension will automatically convert standard quotations to their opening/closing variants:

  • 'single quotes': ‘single quotes’

  • "double quotes": “double quotes”

The linkify extension will automatically identify “bare” web URLs, like www.example.com, and add hyperlinks; www.example.com. This extension requires that linkify-it-py is installed.

The replacements extension will automatically convert some common typographic texts, such as +- -> ±.

The substitution extension allows you to specify “substitution definitions” in either the conf.py (as myst_substitutions) and/or individual file’s front-matter (front-matter takes precedence), which will then replace substitution references. For example:

---
substitutions:
  key1: definition
---
{{ key1 }}

The substitutions are assessed as jinja2 expressions and includes the Sphinx Environment as env, so you can do powerful thinks like:

{{ [key1, env.docname] | join('/') }}

The figure-md directive has been added (replacing enable_figure), which parses a “Markdown friendly” figure (used with the colon_fence extension):

:::{figure-md} fig-target
:class: myclass

<img src="img/fun-fish.png" alt="fishy" class="bg-primary mb-1" width="200px">

This is a caption in **Markdown**
:::

👌 Improvements

Using the html_image extension, HTML images are now processed for both blocks and (now) inline.

So you can correctly do, for example:

I’m an inline image: <img src="img/fun-fish.png" height="20px">

| table column                              |
| ----------------------------------------- |
| <img src="img/fun-fish.png" width="20px"> |

0.12.10 - 2020-09-21

🐛 FIX: allow dates to be parsed in frontmatter.

This fixes a bug that would raise errors at parse time if non-string date objects were in front-matter YAML. See #253

0.12.9 - 2020-09-08

✨ NEW: Auto-generate heading anchors.

This utilises markdown-it-py’s anchors-plugin, to generate unique anchor “slugs” for each header (up to a certain level), and allows them to be referenced via a relative path, e.g. [](./file.md#header-anchor), or in the same document, e.g. [](#header-anchor).

Slugs are generated in the GitHub style (see here); lower-case text, removing punctuation, replacing spaces with -, enforce uniqueness via suffix enumeration -1.

It is enabled in your conf.py via myst_heading_anchors = 2 (sets maximum heading level).

See the documentation here.

🐛 FIX: doc reference resolution for singlehtml/latex.

These reference resolutions are passed to the “missing-reference” event, and require the node["refdoc"] attribute to be available, which was missing for [text](./path/to/file.md) type references.

0.12.7 - 2020-08-31

✨ NEW: Want to include your README.md in the documentation?

See including a file from outside the docs folder.

(👌 added relative-docs option in 0.12.8)

0.12.5 - 2020-08-28

✨ NEW: Add Markdown figure syntax

Setting myst_figure_enable = True in your sphinx conf.py, combines the above two extended syntaxes, to create a fully Markdown compliant version of the figure directive. See Markdown Figures for details.

(👌 formatting of caption improved in 0.12.6)

0.12.4 - 2020-08-27

👌 IMPROVE: the mathjax extension is now only overridden if strictly necessary (to support dollar and ams math), and the override is more precise, to mitigate any unwanted side-effects

0.12.3 - 2020-08-26

✨ NEW: Add definition lists.

This addition, enabled by myst_deflist_enable = True, allows for “Pandoc style” definition lists to be parsed and rendered, e.g.

Term 1
: Definition

See the Definition Lists documentation for further details.

👌 IMPROVE: mathjax_config override.

Only mathjax_config["tex2jax"] will now be overridden, in order to not interfere with other user configurations, such as adding TeX macros. The configuration name has also changed from myst_override_mathjax to myst_update_mathjax. See Mathjax and math parsing for further details.

0.12.2 - 2020-08-25

✨ NEW: Add the eval-rst directive

This directive parses its contents as ReStructuredText, which integrates back into the rest of the document, e.g. for cross-referencing. See this documentation for further explanation.

In particular, this addition solves some outstanding user requests:

Thanks to @stephenroller for the contribution 🎉

0.12.1 - 2020-08-19

✨ NEW: Add myst_commonmark_only config option, for restricting the parser to strict CommonMark (no extensions).

0.12.0 - 2020-08-19

‼️ BREAKING

If you are using math in your documents, be sure to read the updated Math syntax guide! In particular, the Mathjax configuration is now overridden, such that LaTeX environments will only be rendered if myst_amsmath_enable=True is set.

The myst_math_delimiters option has also been removed (please open an issue if you would like brackets math parsing to be re-implemented).

In addition the myst_html_img option name has been changed to myst_html_img_enable.

Some underlying code has also been refactored, to centralise handling of configuration options (see commit 98573b9).

Improved 👌

More configuration options for math parsing (see MyST configuration options).

0.11.2 - 2020-07-13

Added ✨

Improved 👌

  • [title](link) syntax now works with intersphinx references. Recognised URI schemas can also be configured, see the configuration options

0.11.1 - 2020-07-12

Fix

  • Correctly pin required minimum markdown-it-py version

0.11.0 - 2020-07-12

Added ✨

Breaking ‼️

  • Sphinx configuration options are now set as separate variables, rather than a single dict. See MyST configuration options for details.

0.10.0 - 2020-07-08

(full changelog)

Improved 👌