Add Markdown renderer as superfences formatter - #1635
Merged
Conversation
Update relevent code blocks in the documentation to make use of it.
Member
Author
Collaborator
|
Looks good! |
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
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.

Description
If a code block is demonstrating Markdown syntax, if can be assigned the
md-renderattribute, and both the Markdown source and HTML output will be rendered in a nested set of code blocks. This was inspired by PyMdown's custom formatter. The difference is that both the source and output are rendered from a single block, whereas PyMdown's documentation requires defining the two blocks separately. Examples of what the output looks like can be found throughout PyMdown's documentation.The Documentation Style Guide was updated for this and various other changes related to the switch to Zensical.
AI Assistance Disclosure
Checklist