Skip to content

Admonition Fatigue #41

Open
Open

Description

@mrchantey

Just a bit of friendly feedback, I find the admonition use in the book a bit challenging to read.
I've heard the idea of 'admonition fatigue' passed around, to me an admonish reads a bit like SHOUTING. WHEN EVERYTHING IS CAPITAL LETTERS IT GETS NOISY, ESPECIALLY WHEN THE CONTENT IS VERY LONG OR JUST A LINK OR SOMETHING THAT DOES NOT REQUIRE EMPHASIS (im not actually shouting here 🙃)

Love the idea of spicing mdbook up with color, it has great theming support, could be a oneshot prompt to replace the admonishments with something more legible but equally pretty.

Just my personal experience, thanks for the awesome library!

Activity

  1. schungx commented on Mar 11, 2026

    @schungx
    Contributor

    True. With the new version of mdbook the admonish plugin so far does not support it. So it prevents the book from upgrading to the latest version.

    I have been thinking of removing the admonitons but since they are too prevalent and I don't have the time to do it. And I haven't thought about what to replace them with.

    Any suggestions?

  2. mrchantey commented on Mar 12, 2026

    @mrchantey
    Author

    Interesting I'll have a closer look when I get a chance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions