Plugin feedback about admonitions HOT 5 CLOSED

Yeah, I went back and forth on this before I submitted it, but when I first wrote it I just straight up copied the Material for MkDocs syntax and it seemed several people in the forums were using it, so I left it as-is to prevent breaking their already written notes.

I was thinking of just prefixing the ID with ad- (as in, ad-note). Do you think that would be acceptable?

Edit: Also, honestly, I think I'm going to drop the aliases. After using it for awhile I don't see a need for them. It cuts down on the number of code block IDs, but I'll still add the prefix (or type parameter if necessary).

from admonitions.

That could work - in fact one of our mods proposed the ad- prefix as a solution too. In the end I think it's a balance between convenience, how good it looks in code, and how likely it's going to conflict with other plugins. I'm good as long as something is done to address the potential conflict.

from admonitions.

Okay, updated with 2.0.0.

Also, just a quick question related to this - is there an API hook for when a plugin is updated (as opposed to just loaded / installed)? This could be used, for instance, to alert users to syntax changes.

Anyway, thanks for the feedback.

from admonitions.

Thanks for being so responsive (and responsible) on this front, @valentine195!

I'm not sure on the update hook, but you could do a staged deprecation: continue to recognize the previous syntax for an update or two, but present a message in the rendered blocks warning users about what the new syntax should be.

from admonitions.

A staged deprecation would work, but I think in this instance it was better to just rip the band-aid off 😁

from admonitions.