spacedentist / spr

Submit pull requests for individual, amendable, rebaseable commits to GitHub
https://getcord.github.io/spr/
MIT License
377 stars 33 forks source link

Book: add mdbook preprocessor for embedded mermaid diagrams #141

Closed sven-of-cord closed 1 year ago

sven-of-cord commented 1 year ago

This is needed for #126, which adds a new page that uses mermaid diagrams.

I reworked the book workflow a little, now using the GitHub cache action to speed things up.

Test Plan: after submitting this PR, I will update it with temporary modifications to GitHub workflow and docs to test this. If all is well, I remove those temporary changes again

sven-of-cord commented 1 year ago

With the temporary changes in this PR (which includes the new Markdown file from #126 and an additional trigger in the GitHub Actions workflow to build the book for this PR), I could verify that this is working.

I checked https://getcord.github.io/spr/reference/how-it-works-simple.html: Screenshot