-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automate SVG rendering in MkDocs #49
Merged
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
to optimize git repo size
and wrap vertically when more than one SVG for the same snippet
fizruk
reviewed
May 31, 2023
fizruk
reviewed
May 31, 2023
fizruk
reviewed
May 31, 2023
Thank you! Looks good modulo minor comments which I left above. |
Merged
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.
Removed the hard-coded SVGs from the markdown and instead wrote a tiny MkDocs plugin (hook) that renders them from the fenced code blocks. One shortcoming is that the RegEx used for detecting code blocks is too simple and doesn't cover all possible markdown syntaxes. Additionally, this depends on the existence of the
rzk
executable in thePATH
.I also added a step to the GitHub Action to install rzk since MkDocs now depends on it for rendering.
Additionally, I modified the GH Pages publish steps to be
single-commit
to optimize the git repo size (in the future, I would recommend usingactions/deploy-pages
instead, which does not depend on having agh-pages
branch)