packages/mdbook-trpl/src/bin/README - mdbook-trpl-note.md
This is a very simple preprocessor for mdBook, focused specifically on the content of The Rust Programming Language book. This preprocessor takes Markdown like this—
> Note: This is some material we want to provide more emphasis for, because it
> is important in some way!
Some text.
> ## Some subject
>
> Here is all the important things to know about that particular subject.
—and rewrites the Markdown to this:
<section class="note" aria-role="note">
This is some material we want to provide more emphasis for, because it is
important in some way!
</section>
Some text.
<section class="note" aria-role="note">
## Some subject
Here is all the important things to know about that particular subject.
</section>
This allows using the relatively standard Markdown convention of (incorrectly!) using blockquotes for “callouts” or “notes” like this, while still producing semantic HTML which conveys the actual intent.
[!NOTE] This is not a full “admonition” preprocessor, and it is not remotely compliant with the GitHub “alert” syntax. It exists almost entirely for the sake of providing better semantic HTML for The Rust Programming Language book with a minimum of disruption to existing workflows!
You are probably better off using one of the other existing alert/admonition preprocessors: