executablebooks/MyST-Parser (myst_parser)
### [`v0.19.2`](https://togithub.com/executablebooks/MyST-Parser/blob/HEAD/CHANGELOG.md#0192---2023-03-02)
[Compare Source](https://togithub.com/executablebooks/MyST-Parser/compare/v0.19.1...v0.19.2)
✨ NEW: Add myst_fence_as_directive config ()
Setting the following config, for example:
```python
extensions = ["myst_parser", "sphinxcontrib.mermaid"]
myst_fence_as_directive = ["mermaid"]
```
### [`v0.19.1`](https://togithub.com/executablebooks/MyST-Parser/blob/HEAD/CHANGELOG.md#0191---2023-03-07)
[Compare Source](https://togithub.com/executablebooks/MyST-Parser/compare/v0.19.0...v0.19.1)
🐛 FIX `NoURI` error in doc reference resolution, for texinfo builds ()
### [`v0.19.0`](https://togithub.com/executablebooks/MyST-Parser/blob/HEAD/CHANGELOG.md#0190---2023-03-01)
[Compare Source](https://togithub.com/executablebooks/MyST-Parser/compare/v0.18.1...v0.19.0)
This release brings a number of exciting new features, improvements, and upgrades 🎉
Full Changelog: [v0.18.1...v0.19.0](https://togithub.com/executablebooks/MyST-Parser/compare/v0.18.1...v0.19.0)
##### 📚 Rewritten documentation
The documentation has been almost completely rewritten,
with a clearer structure, many more examples, rich hover tips, and a new live preview page ⚡️ (powered by [pyscript](https://pyscript.readthedocs.io/), ).
The code base API is also now fully documented by [sphinx-autodoc2](https://sphinx-autodoc2.readthedocs.io/), which even allows for MyST docstrings! ().
##### ⬆️ Add Sphinx 6 support, drop Sphinx 4
The code base has been updated to support sphinx v6, and is no longer tested against sphinx v4 ()
##### 📄 Extended docutils (single-page) support
The `docutils` parser now supports many more features, and improvements to support live previews:
- `myst_suppress_warnings` option added, mirroring Sphinx, to suppress MyST warnings ()
- `myst_meta_html` and `myst_substitutions` options are now supported ()
- `myst_heading_anchors` option is now supported ()
- Math block labels syntax is now supported ()
- Missing directive/role errors errors are now suppressable warnings ()
- Non-fatal directive parsing errors are now suppressable warnings ()
- Most of the extended markdown syntax below is also supported
##### 🔗 Extended Markdown links
See the [Extended Markdown links](docs/syntax/cross-referencing.md) section for the full guide.
You can now use standard Markdown link syntax to reference many different types of targets, in a more consistent way.
- `[text](relative/path/myfile.md)` work as previously, to link to files,
but they can also be relative to source directory: `[text](/path/from/srcdir/myfile.md)`.
You can also use ``
- `` will link specifically to a downloadable file
- `[text](#target)` or `` will link (in order of priority) to any local target, local heading anchor, target in the same project, or intersphinx (inventory) target
- `[text](inv:name:domain:type#target)` will link specifically to a Sphinx inventory target, or to any inventory ``, and can even use `*` wildcards like ``
- This can even be used in docutils, with the new `myst_inventories` config option
- The `myst-inv` CLI makes it easy to find the correct inventory target
:::{tip}
It is advised (although not immediately necessary) to prefix all internal references with `#`.
For example, `[...](my-reference)`, should be changed to `[...](#my-reference)`.
:::
##### `{}` Attributes syntax
The [`attrs_inline` and `attrs_block`](docs/syntax/optional.md#attributes) extensions allow for common Markdown syntaxes to be extended with greater control over the output.
For example, you can now add classes, ids, and other attributes to inline code, images, and links, as well as to code blocks and directives.
- Inline code: `` `a = 1`{#id .class l=python} ``
- Images: `{#id .class width=100px}`
- Text spans: `[some text]{#id .class}`
A paragraph block can have attributes too:
```markdown
{#id .class}
This is a paragraph with an id and class
```
A code fence can be given line numbers and line emphasis:
````markdown
{#id .class lineno-start=1 emphasize-lines="2,3"}
```python
a = 1
b = 2
c = 3
```
````
A definition list can be turned into a glossary, with referenceable terms:
```markdown
{.glossary}
term name
: Definition of the term
```
Quote blocks can be given an attribution:
```markdown
{attribution="Chris Sewell"}
> My quote
```
##### 👌 Miscellaneous improvements
- Nested headings (e.g. inside directives) are now allowed in MyST and are correctly rendered in HTML ()
- The `colon_fence` extension now renders internal content as MyST, rather than as a code block ()
- The `include` directive in MyST documents now supports a `:heading-offset:` option, to offset the heading levels in the included document
- The `myst_heading_slug_func` option now supports setting a `str` which points to a fully qualified function name, e.g. `"module.path.func"` ()
- The `myst_enable_checkboxes` option allows for task list checkboxes to be enabled/disabled ()
##### Additional contributions
- 🐛 FIX: Remove unnecessary assert in , thanks to
- 🔧 ci(deps): setup dependabot (), thanks to
- 🔧: Depend on typing_extensions only on `Python<3.8` in , thanks to
### [`v0.18.1`](https://togithub.com/executablebooks/MyST-Parser/blob/HEAD/CHANGELOG.md#0181---2022-27-09)
[Compare Source](https://togithub.com/executablebooks/MyST-Parser/compare/v0.18.0...v0.18.1)
Full Changelog: [v0.18.0...v0.18.1](https://togithub.com/executablebooks/MyST-Parser/compare/v0.18.0...v0.18.1)
- ⬆️ UPGRADE: docutils 0.19 support in
- ✨ NEW: Add `attrs_image` (experimental) extension in
- e.g. `{#id .class width=100px}`
- See: [Optional syntax section](docs/syntax/optional.md)
- **Important**: This is an experimental extension, and may change in future releases
### [`v0.18.0`](https://togithub.com/executablebooks/MyST-Parser/blob/HEAD/CHANGELOG.md#0180---2022-06-07)
[Compare Source](https://togithub.com/executablebooks/MyST-Parser/compare/v0.17.2...v0.18.0)
Full Changelog: [v0.17.2...v0.18.0](https://togithub.com/executablebooks/MyST-Parser/compare/v0.17.2...v0.18.0)
This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow.
It also introduces **document-level configuration** *via* the Markdown front-matter, under the `myst` key.
See the [Local configuration](docs/configuration.md) section for more information.
##### Breaking changes
This should not be breaking, for general users of the sphinx extension (with `sphinx>3`),
but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.
The `to_docutils`, `to_html`, `to_tokens` (from `myst_parser/main.py`) and `mock_sphinx_env`/`parse` (from `myst_parser.sphinx_renderer.py`) functions have been removed, since these were primarily for internal testing.
Instead, for single page builds, users should use the docutils parser API/CLI (see [](docs/docutils.md)),
and for testing, functionality has been moved to .
The top-level `html_meta` and `substitutions` front-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the `myst` config, e.g.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
==0.17.2->==0.19.2Release Notes
executablebooks/MyST-Parser (myst_parser)
### [`v0.19.2`](https://togithub.com/executablebooks/MyST-Parser/blob/HEAD/CHANGELOG.md#0192---2023-03-02) [Compare Source](https://togithub.com/executablebooks/MyST-Parser/compare/v0.19.1...v0.19.2) ✨ NEW: Add myst_fence_as_directive config (Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.