Skip to content
Notes

callouts mdbook extention

What “mdbook-callouts” does, in one minute GrayJack/rs-mdbook-callouts

What it is. A preprocessor for mdBook that converts Obsidian-style callouts—blockquote lines that start with > [!TYPE]—into styled “alert/callout” boxes in the rendered book (INFO, NOTE, TIP, IMPORTANT, WARNING, etc.). It also supports custom titles like > [!NOTE] My title. GrayJack/rs-mdbook-callouts Obsidian Help: Callouts

How it works. During mdbook build, the plugin scans Markdown for callout syntax and rewrites it to HTML with the appropriate classes and bundled assets, so your HTML output shows shaded boxes with icons and headings. No authoring changes beyond using the callout markers. GrayJack/rs-mdbook-callouts docs.rs: mdbook-callouts

Supported syntax (examples). GrayJack/rs-mdbook-callouts Obsidian Help: Callouts

Install + enable. GrayJack/rs-mdbook-callouts docs.rs: mdbook-callouts

  1. cargo install mdbook-callouts
  2. In book.toml: [preprocessor.callouts]

That’s it—build as usual with mdbook build. GrayJack/rs-mdbook-callouts

Limitations to note. Fold/collapse markers from Obsidian ([!type]- for collapsed, [!type]+ for expanded) aren’t fully supported in the upstream lineage; expect plain, always-open boxes unless you add custom JS/CSS. Track upstream issue for foldables. rs-mdbook-alerts Issue #71 Obsidian Help: Callouts

Related option (different authoring style). If you prefer fenced blocks over blockquotes, mdbook-admonish gives ```admonish note ... ``` style admonitions with a mature asset pipeline and reference docs. tommilligan/mdbook-admonish

Bottom line. Use mdbook-callouts when your source already uses Obsidian callouts and you want them to render the same in mdBook without rewriting content. Use mdbook-admonish if you want a fence-based, themeable alternative. GrayJack/rs-mdbook-callouts tommilligan/mdbook-admonish