actions-mdbook icon indicating copy to clipboard operation
actions-mdbook copied to clipboard

proposal: Add option to install `mdbook-mermaid`

Open jorgecarleitao opened this issue 2 years ago • 13 comments

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

jorgecarleitao avatar Mar 09 '22 19:03 jorgecarleitao

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

bgianfo avatar Apr 18 '22 01:04 bgianfo

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

peaceiris avatar Apr 19 '22 14:04 peaceiris

Just as an FYI, mdbook-admonish now produces pre-built binaries.

bgianfo avatar Apr 21 '22 23:04 bgianfo

I'd like to see mdbook-template as well 😄

https://github.com/sgoudham/mdbook-template/releases/tag/v1.0.0

yaleman avatar Jul 02 '22 00:07 yaleman

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.

zanglg avatar Jul 08 '22 04:07 zanglg

👀

peaceiris avatar Jul 08 '22 04:07 peaceiris

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.

expikr avatar Apr 10 '23 08:04 expikr

I'd like to add the mdbook-d2 plugin for consideration.

https://d2lang.com/

kevinmichaelchen avatar Aug 25 '23 15:08 kevinmichaelchen

I found this issue wanting support for mdbook-quiz 🙏.

bartvanderwal avatar Nov 04 '23 04:11 bartvanderwal