Merge pull request #11441 from eth3lbert/markdown-render-alert

Turbo87 · web-flow · commit 721b46e725fe · 2025-07-01T12:01:18.000+02:00
Add support for rendering alerts in README
diff --git a/app/styles/crate/version.module.css b/app/styles/crate/version.module.css
@@ -152,3 +152,105 @@
         border: 0;
     }
 }
+
+/* alerts */
+:global(.markdown-alert) {
+    --fg-color-note: #4494f8;
+    --fg-color-tip: #3fb950;
+    --fg-color-important: #ab7df8;
+    --fg-color-warning: #d29922;
+    --fg-color-caution: #f85149;
+
+    padding: 0.5rem 1rem;
+    margin-bottom: 1rem;
+    color: inherit;
+    border-left: .25em solid var(--gray-border);
+
+    & > :first-child {
+        margin-top: 0;
+    }
+
+    & > :last-child {
+        margin-bottom: 0;
+    }
+
+    :global(.markdown-alert-title) {
+        display: flex;
+        font-weight: 500;
+        align-items: center;
+        line-height: 1;
+    }
+
+    & > :global(.markdown-alert-title)::before {
+        content: '';
+        margin-right: .5rem;
+        background-color: var(--gray-border);
+        width: 1em;
+        height: 1em;
+    }
+
+    &:global(.markdown-alert-note) {
+        border-left-color: var(--fg-color-note);
+
+        & > :global(.markdown-alert-title) {
+            color: var(--fg-color-note);
+
+            &:before {
+                mask: url("/assets/alert-note.svg");
+                background-color: var(--fg-color-note);
+            }
+        }
+    }
+
+    &:global(.markdown-alert-tip) {
+        border-left-color: var(--fg-color-tip);
+
+        & > :global(.markdown-alert-title) {
+            color: var(--fg-color-tip);
+
+            &:before {
+                mask: url("/assets/alert-tip.svg");
+                background-color: var(--fg-color-tip);
+            }
+        }
+    }
+
+    &:global(.markdown-alert-important) {
+        border-left-color: var(--fg-color-important);
+
+        & > :global(.markdown-alert-title) {
+            color: var(--fg-color-important);
+
+            &:before {
+                mask: url("/assets/alert-important.svg");
+                background-color: var(--fg-color-important);
+            }
+        }
+    }
+
+    &:global(.markdown-alert-warning) {
+        border-left-color: var(--fg-color-warning);
+
+        & > :global(.markdown-alert-title) {
+            color: var(--fg-color-warning);
+
+            &:before {
+                mask: url("/assets/alert-warning.svg");
+                background-color: var(--fg-color-warning);
+            }
+        }
+    }
+
+    &:global(.markdown-alert-caution) {
+        border-left-color: var(--fg-color-caution);
+
+        & > :global(.markdown-alert-title) {
+            color: var(--fg-color-caution);
+
+            &:before {
+                mask: url("/assets/alert-caution.svg");
+                background-color: var(--fg-color-caution);
+            }
+        }
+    }
+}
diff --git a/crates/crates_io_markdown/lib.rs b/crates/crates_io_markdown/lib.rs
@@ -46,6 +46,18 @@ impl<'a> MarkdownRenderer<'a> {
                 ]),
             ),
             ("section", hashset(&["footnotes"])),
+            (
+                "div",
+                hashset(&[
+                    "markdown-alert",
+                    "markdown-alert-note",
+                    "markdown-alert-tip",
+                    "markdown-alert-important",
+                    "markdown-alert-warning",
+                    "markdown-alert-caution",
+                ]),
+            ),
+            ("p", hashset(&["markdown-alert-title"])),
         ]);
         let sanitize_url = UrlRelative::Custom(Box::new(SanitizeUrl::new(base_url, base_dir)));
 
@@ -77,7 +89,9 @@ impl<'a> MarkdownRenderer<'a> {
             .build();
 
         let extension_options = ComrakExtensionOptions::builder()
+            .alerts(true)
             .autolink(true)
+            .multiline_block_quotes(true)
             .strikethrough(true)
             .table(true)
             .tagfilter(true)
@@ -429,7 +443,7 @@ mod tests {
     #[test]
     fn text_with_forbidden_class_attribute() {
         let text = "<p class='bad-class'>Hello World!</p>";
-        assert_snapshot!(markdown_to_html(text, None, ""), @"<p>Hello World!</p>");
+        assert_snapshot!(markdown_to_html(text, None, ""), @r#"<p class="">Hello World!</p>"#);
     }
 
     #[test]
@@ -684,4 +698,36 @@ There can also be some text in between!
         </ul>
         "##);
     }
+
+    #[test]
+    fn alerts_note() {
+        let text = r#"
+> [!note]
+> Hello, world!
+        "#;
+        assert_snapshot!(markdown_to_html(text, None, ""), @r#"
+        <div class="markdown-alert markdown-alert-note">
+        <p class="markdown-alert-title">Note</p>
+        <p>Hello, world!</p>
+        </div>
+        "#);
+    }
+
+    #[test]
+    fn alerts_note_multiline_block_quotes() {
+        let text = r#"
+>>> [!note]
+Hello,
+
+world!
+>>>
+"#;
+        assert_snapshot!(markdown_to_html(text, None, ""), @r#"
+        <div class="markdown-alert markdown-alert-note">
+        <p class="markdown-alert-title">Note</p>
+        <p>Hello,</p>
+        <p>world!</p>
+        </div>
+        "#);
+    }
 }
diff --git a/e2e/acceptance/readme-rendering.spec.ts b/e2e/acceptance/readme-rendering.spec.ts
@@ -2,6 +2,39 @@ import { expect, test } from '@/e2e/helper';
 import { http, HttpResponse } from 'msw';
 
 const README_HTML = `
+<div class="markdown-alert markdown-alert-note">
+<p class="markdown-alert-title">Note</p>
+<p>Useful information that users should know, even when skimming content.</p>
+</div>
+<div class="markdown-alert markdown-alert-tip">
+<p class="markdown-alert-title">Tip</p>
+<p>Helpful advice for doing things better or more easily.</p>
+</div>
+<div class="markdown-alert markdown-alert-important">
+<p class="markdown-alert-title">Important</p>
+<p>Key information users need to know to achieve their goal.</p>
+</div>
+<div class="markdown-alert markdown-alert-warning">
+<p class="markdown-alert-title">Warning</p>
+<p>Urgent info that needs immediate user attention to avoid problems.</p>
+</div>
+<div class="markdown-alert markdown-alert-caution">
+<p class="markdown-alert-title">Caution</p>
+<p>Advises about risks or negative outcomes of certain actions.</p>
+</div>
+
+<div class="markdown-alert markdown-alert-note">
+<p class="markdown-alert-title">Note</p>
+<div class="markdown-alert markdown-alert-important">
+<p class="markdown-alert-title">Important</p>
+<div class="markdown-alert markdown-alert-caution">
+<p class="markdown-alert-title">Caution</p>
+<p>Rick roll</p>
+<p>Never gonna give you up</p>
+</div>
+</div>
+</div>
+
 <p><strong>Serde is a framework for <em>ser</em>ializing and <em>de</em>serializing Rust data structures efficiently and generically.</strong></p>
 <hr>
 <p>You may be looking for:</p>
diff --git a/public/assets/alert-caution.svg b/public/assets/alert-caution.svg
@@ -0,0 +1,3 @@
+<svg class="octicon octicon-stop mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true" xmlns="https://www.w3.org/2000/svg">
+    <path d="M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path>
+</svg>
diff --git a/public/assets/alert-important.svg b/public/assets/alert-important.svg
@@ -0,0 +1,3 @@
+<svg class="octicon octicon-report mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true" xmlns="https://www.w3.org/2000/svg">
+    <path d="M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path>
+</svg>
diff --git a/public/assets/alert-note.svg b/public/assets/alert-note.svg
@@ -0,0 +1,3 @@
+<svg class="octicon octicon-info mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true" xmlns="https://www.w3.org/2000/svg">
+    <path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path>
+</svg>
diff --git a/public/assets/alert-tip.svg b/public/assets/alert-tip.svg
@@ -0,0 +1,3 @@
+<svg class="octicon octicon-light-bulb mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true" xmlns="https://www.w3.org/2000/svg">
+    <path d="M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z"></path>
+</svg>
diff --git a/public/assets/alert-warning.svg b/public/assets/alert-warning.svg
@@ -0,0 +1,3 @@
+<svg class="octicon octicon-alert mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true" xmlns="https://www.w3.org/2000/svg">
+    <path d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path>
+</svg>
diff --git a/tests/acceptance/readme-rendering-test.js b/tests/acceptance/readme-rendering-test.js
@@ -9,6 +9,39 @@ import { setupApplicationTest } from 'crates-io/tests/helpers';
 import { visit } from '../helpers/visit-ignoring-abort';
 
 const README_HTML = `
+<div class="markdown-alert markdown-alert-note">
+<p class="markdown-alert-title">Note</p>
+<p>Useful information that users should know, even when skimming content.</p>
+</div>
+<div class="markdown-alert markdown-alert-tip">
+<p class="markdown-alert-title">Tip</p>
+<p>Helpful advice for doing things better or more easily.</p>
+</div>
+<div class="markdown-alert markdown-alert-important">
+<p class="markdown-alert-title">Important</p>
+<p>Key information users need to know to achieve their goal.</p>
+</div>
+<div class="markdown-alert markdown-alert-warning">
+<p class="markdown-alert-title">Warning</p>
+<p>Urgent info that needs immediate user attention to avoid problems.</p>
+</div>
+<div class="markdown-alert markdown-alert-caution">
+<p class="markdown-alert-title">Caution</p>
+<p>Advises about risks or negative outcomes of certain actions.</p>
+</div>
+
+<div class="markdown-alert markdown-alert-note">
+<p class="markdown-alert-title">Note</p>
+<div class="markdown-alert markdown-alert-important">
+<p class="markdown-alert-title">Important</p>
+<div class="markdown-alert markdown-alert-caution">
+<p class="markdown-alert-title">Caution</p>
+<p>Rick roll</p>
+<p>Never gonna give you up</p>
+</div>
+</div>
+</div>
+
 <p><strong>Serde is a framework for <em>ser</em>ializing and <em>de</em>serializing Rust data structures efficiently and generically.</strong></p>
 <hr>
 <p>You may be looking for:</p>
