Markdown links are of the format [text](https://github.com/executablebooks/MyST-Parser/blob/master/link).
MyST-Parser looks to smartly resolve such links, by identifying if they are:
A link to an external resource, e.g. [text](http://example.com)
A link to another source document, e.g. [text](https://github.com/executablebooks/MyST-Parser/blob/master/file.md)
If header-anchors are enabled, anchor links are also supported, e.g. [text](https://github.com/executablebooks/MyST-Parser/blob/master/file.md#anchor)
A link to an internal sphinx cross-reference, e.g. [text](https://github.com/executablebooks/MyST-Parser/blob/master/my-reference)
an additional situation is now supported:
A link to a source file, which is not a document, e.g. [text](https://github.com/executablebooks/MyST-Parser/blob/master/file.js). This behaves similarly to the sphinx download role.
In addition, configuration to more finely tune this behaviour has been added.
myst_all_links_external=True, will make all links be treated as (1)
myst_url_schemes=("http", "https"), sets what URL schemes are treated as (1)
myst_ref_domains=("std", "py"), sets what Sphinx reference domains are checked, when handling (3)
The default configuration is now myst_enable_extensions=(), instead of myst_enable_extensions=("dollarmath",).
If you are using math enclosed in $ or $$ in your documents, you should enable dollarmath explicitly.
MyST-Parser now supports, and is tested against, Python 3.7 to 3.10.
✨ Add the strikethrough extension and myst_gfm_only configuration
The strikethrough extension allows text within ~~ delimiters to have a strike-through (horizontal line) placed over it.
For example, ~~strikethrough with *emphasis*~~ renders as: strikethrough with emphasis.
Important: This extension is currently only supported for HTML output.
The myst_gfm_only=True configuration sets up specific configuration, to enable compliance only with GitHub-flavored Markdown, including enabling the strikethrough, tasklist and linkify extensions, but disabling support for roles and directives.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
xmnlab
commented
2 years ago
Bumps myst-parser from 0.16.1 to 0.17.0.
Release notes
Sourced from myst-parser's releases.
Changelog
Sourced from myst-parser's changelog.
... (truncated)
Commits
e477a75🚀 RELEASE: 0.17.0 (#507)7654462🔧 TESTS: Fix for sphinx 4.4 (#508)ee5ff3b‼️ BREAKING: Remove dollarmath from defaultmyst_enable_extensions(#505)ad6e39d🔧 MAINTAIN: ImplementMockInliner.parse(#504)707d9d5✨ NEW: Addstrikethroughextension (#502)c3945bb✨ NEW: Addmyst_gfm_onlyconfiguration (#501)05c0905🧪 TESTS: Update pytest-param-files (#500)c90be9a🐛 FIX: linkify link rendering (#499)574b525✨ NEW: Addmyst_title_to_headerconfiguration (#492)74e91e6🔀 MERGE: Internal improvements to the code base (#498)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)