Skip to content

Discuss alternatives to mdbook-alerts for callout preprocessors #230

Open
@mkatychev

Description

@mkatychev

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:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions