component-docs icon indicating copy to clipboard operation
component-docs copied to clipboard

Adopt mdbook-alerts for Note comments

Open rajsite opened this issue 1 year ago • 1 comments

In #149 Note: comments were made consistent as just comment blocks. In discussion https://github.com/bytecodealliance/component-docs/pull/149#issuecomment-2316155910 the idea was proposed to improve in the future.

Found the mdbook-alerts crate which adds support for the GitHub Flavored Markdown Alerts feature which could be used to address this.

rajsite avatar Sep 09 '24 14:09 rajsite

Those look really nice, and much more nuanced than the aside format. Great find!

itowlson avatar Sep 09 '24 20:09 itowlson

This is done! @itowlson / @kate-goldenring -- this should be closable :) we're using mdbook-alerts

vados-cosmonic avatar Apr 14 '25 03:04 vados-cosmonic