Handle mkdocs/GitHub admonition conversions #466
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
GitHub doesn't natively render mkdocs admonitions, making the markdown docs hard to read in the repo. This script allows us to maintain a "GitHub-first" source while deploying a "Mkdocs-working" site by introducing the convert_docs script.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
GitHub doesn't natively render mkdocs admonitions, making the markdown docs hard to read in the repo.
The pure GitHub markdown loses styling consistency provided by mkdocs admonitions.
This PR adds a script that allows us to maintain a "GitHub-first" source while deploying a "Mkdocs-working" site by introducing the convert_docs script.