actions-mdbook
actions-mdbook copied to clipboard
proposal: Add option to install `mdbook-mermaid`
Checklist
- [X] I am using the latest version of this action.
- [X] I have read the latest README and followed the instructions.
- [X] I have read the latest GitHub Actions official documentation and learned the basic spec and concepts.
Describe your proposal
Have an option / boolean parameter to install https://github.com/badboy/mdbook-mermaid, which allows to compile mermaid diagrams in guides docs.
Describe the solution you'd like
A simple parameter to optionally install mdbook-mermaid
Describe alternatives you've considered
Doing it manually
Additional context
None
I think generic preprocessor support would be awesome, there are a few I am interested in personally:
- mdbook-admonish
- mdbook-mermaid
- mdbook-toc
- mdbook-linkcheck
Other preprocessors except mdbook-admonish have pre-built binaries, so it looks possible to implement them.
Preprocessor name | Binary assets |
---|---|
mdbook-admonish | No |
mdbook-mermaid | Yes |
mdbook-toc | Yes |
mdbook-linkcheck | Yes |
Just as an FYI, mdbook-admonish
now produces pre-built binaries.
I'd like to see mdbook-template as well 😄
https://github.com/sgoudham/mdbook-template/releases/tag/v1.0.0
I found mdbook-kroki-preprocessor, another excellent preprocessor which provides a unified API with support for many well-known textual graphs. Hope also give a support of.
👀
and mdbook-katex
https://github.com/SichangHe/mdbook_katex_static_css/pull/8#discussion_r1161554789
I propose editing the title of this issue to be about Preprocessors in general.
I found this issue wanting support for mdbook-quiz
🙏.