Recommend MyST-Parser for Markdown usage #9112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Recommend MyST-Parser for Markdown usage, instad of recommonmark.
Feature or Bugfix
Not sure if I'd consider this a feature, a bugfix or a refactoring, but if I had to choose I guess it would be a bugfix.
Purpose
The recommonmark maintainers have proposed to sunset recommonmark in favor of MyST-Parser since the latter enjoys more community support, is more flexible, and has a brighter future. A few projects have already migrated since the announcement was made, and so far nobody has found unexpected problems. Both projects are configured as Sphinx extensions and work in a very similar way.
Disclaimer: I started working recently at Read the Docs as Developer Advocate, and my mission is to help projects improve their documentation. In particular, Sphinx is a core piece of what we do ❤️ and I would like to make more contributions in the future!
Relates
readthedocs/recommonmark#221