Skip to content
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 10 commits into from Jun 15, 2023
Merged

Automate SVG rendering in MkDocs #49

merged 10 commits into from Jun 15, 2023

Conversation

aabounegm
Copy link
Member

@aabounegm aabounegm commented May 30, 2023

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 the PATH.
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 using actions/deploy-pages instead, which does not depend on having a gh-pages branch)

rzk/src/Rzk/TypeCheck.hs Outdated Show resolved Hide resolved
@fizruk
Copy link
Member

fizruk commented May 31, 2023

Thank you! Looks good modulo minor comments which I left above.

@fizruk fizruk merged commit f81e485 into rzk-lang:develop Jun 15, 2023
1 check passed
@fizruk fizruk mentioned this pull request Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants