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

Book: add mdbook preprocessor for embedded mermaid diagrams #141

Conversation

sven-of-cord
Copy link
Contributor

@sven-of-cord sven-of-cord commented Sep 22, 2022

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 Over added 3 commits September 22, 2022 11:26
Created using spr 1.3.5-beta.1
Created using spr 1.3.5-beta.1

[skip ci]
Created using spr 1.3.5-beta.1
@sven-of-cord
Copy link
Contributor Author

sven-of-cord commented Sep 22, 2022

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

Sven Over added 4 commits September 22, 2022 11:40
Created using spr 1.3.5-beta.1
Created using spr 1.3.5-beta.1
Created using spr 1.3.5-beta.1
Created using spr 1.3.5-beta.1
@sven-of-cord sven-of-cord marked this pull request as ready for review September 22, 2022 11:01
Sven Over added 2 commits September 22, 2022 13:24
Created using spr 1.3.5-beta.1

[skip ci]
Created using spr 1.3.5-beta.1
@sven-of-cord sven-of-cord changed the base branch from spr/sven-of-cord/master.book-add-mdbook-preprocessor-for-embedded-mermaid-diagrams to master September 22, 2022 12:25
@sven-of-cord sven-of-cord merged commit 72fe023 into master Sep 22, 2022
@sven-of-cord sven-of-cord deleted the spr/sven-of-cord/book-add-mdbook-preprocessor-for-embedded-mermaid-diagrams branch September 22, 2022 12:25
clarityflowers pushed a commit to clarityflowers/spr that referenced this pull request Mar 19, 2024
This is needed for spacedentist#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

Reviewers: jozef-mokry, flooey

Reviewed By: flooey

Pull Request: spacedentist#141
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