Rewrite the guides to Markdown #450
Open
Conversation
This file contains hidden or 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
linkify extra was added to the `myst-parser` dependency and `uv.lock` was updated accordingly.
Please note that the MyST syntax of several elements (e.g., admonitions, images, cross-references etc.) is different from the syntax used by MkDocs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In the spirit of #434, I rewrote all the pages under "guides" to markdown. If this gets accepted, I can continue to rewrite the rest of the docs.
However, if we end up using MkDocs, please note that MyST (the markdown parser for Sphinx) use a different syntax than MkDocs for several elements:
{slack}`<...>`,{twitter}`<...>`,{gh-repo}`<...>`- those will need to be re-implemented as plugins, or just rewritten as plain links (might be an better option).There might be more differences, but these are the ones I run into. Additonal work will be needed to get it working properly under MkDocs.