ImperialCollegeLondon / ImperialCollegeLondon/virtual_ecosystem

Keep an eye on `myst-parser` and `myst-nb` updates

Open
#238 0 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
20
Forks
5
Avg merge
2d 1h
Merged PRs (30d)
34

Description

**Is your feature request related to a problem? Please describe.**

The `myst-parser` package went to version `1.0.0` a couple of months back and so some of syntax and features should now be stable. Notably, we don't use `colon-fence`s much, and those now seem like canonical syntax.

At the moment, we're currently pinned to `myst-parser <1.0.0` by some `myst-nb` and `sphinx` version pins for using MyST documents as notebooks and as Sphinx content ( see https://github.com/executablebooks/MyST-NB/pull/513). As and when that is resolved we should review our MyST content and syntax.

**Describe the solution you'd like**

Review the MyST docs to update syntax to 1.0.0

Contributor guide

Open the contributing guide

Research direction

Start by checking the repository's MyST documentation and the myst-parser/myst-nb version constraints mentioned in the issue. Review the MyST content for syntax changes once those pins are resolved; done means the relevant documentation uses syntax compatible with myst-parser 1.0.0.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.