Skip to content

Discuss alternatives to mdbook-alerts for callout preprocessors #230

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

Open
mkatychev opened this issue Mar 25, 2025 · 0 comments
Open

Discuss alternatives to mdbook-alerts for callout preprocessors #230

mkatychev opened this issue Mar 25, 2025 · 0 comments

Comments

@mkatychev
Copy link
Contributor

mkatychev commented Mar 25, 2025

mdbook-alerts seems "good enough" for both the web and Github display, but IMO this is worth bringing up so that everyone can discuss

Originally posted by @vados-cosmonic in #218 (comment)

mdbook-admonish is one alternative to consider for this role:

Pros:

  • In use by popular projects such as Tree-sitter
  • Uses material design (somewhat subjective but it styling feels clearer)
  • handles console outputs as their own element
  • does not need workarounds to play nice with mdbook-linkcheck

Cons:

@mkatychev mkatychev changed the title Yeah, mdbook-alerts seems "good enough" for both the web and Github display, but IMO this is worth bringing up so that everyone can discuss -- would you mind making an issue for this? Discuss alternatives to mdbook-alerts for callout preprocessors Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant