Use upstream mdBook admonitions where possible #2235
+40
−48
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,17 +15,11 @@ use regex::{Captures, Regex}; | |
| use std::sync::LazyLock; | ||
|
|
||
| /// The Regex for the syntax for blockquotes that have a specific CSS class, | ||
| /// like `> [!EXAMPLE]`. | ||
| static ADMONITION_RE: LazyLock<Regex> = LazyLock::new(|| { | ||
| Regex::new(r"(?m)^ *> \[!(?<admon>[^]]+)\]\n(?<blockquote>(?: *>.*\n)+)").unwrap() | ||
| }); | ||
|
|
||
| // This icon is from GitHub, MIT License, see https://github.com/primer/octicons | ||
| const ICON_EXAMPLE: &str = r#"<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Zm4.879-2.773 4.264 2.559a.25.25 0 0 1 0 .428l-4.264 2.559A.25.25 0 0 1 6 10.559V5.442a.25.25 0 0 1 .379-.215Z"></path>"#; | ||
|
|
||
|
|
@@ -34,11 +28,11 @@ const ICON_EXAMPLE: &str = r#"<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a | |
| /// The blockquote should look something like: | ||
| /// | ||
| /// ```markdown | ||
| /// > [!EXAMPLE] | ||
| /// > ... | ||
| /// ``` | ||
| /// | ||
| /// This will add a `<div class="alert alert-example">` around the | ||
| /// blockquote so that it can be styled differently, and injects an icon. | ||
| /// The actual styling needs to be added in the `reference.css` CSS file. | ||
| pub fn admonitions(chapter: &Chapter, diag: &mut Diagnostics) -> String { | ||
|
|
@@ -54,7 +48,7 @@ pub fn admonitions(chapter: &Chapter, diag: &mut Diagnostics) -> String { | |
| format!( | ||
| "{space}<div class=\"alert alert-{class}\">\n\ | ||
| \n\ | ||
| {space}> <p class=\"blockquote-tag-title\">\ | ||
| {content}</p>\n\ | ||
| {space} >\n\ | ||
| {blockquote}\n\ | ||
|
|
@@ -73,9 +67,13 @@ pub fn admonitions(chapter: &Chapter, diag: &mut Diagnostics) -> String { | |
| ); | ||
| } | ||
|
|
||
| match lower.as_str() { | ||
| "note" => return caps[0].to_string(), | ||
| "warning" => return caps[0].to_string(), | ||
| _ => (), | ||
| }; | ||
|
|
||
| let svg = match lower.as_str() { | ||
| "example" => ICON_EXAMPLE, | ||
| _ => { | ||
| warn_or_err!( | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -311,6 +311,16 @@ fn compute_replacements<'a>( | |||||
| for (url, link) in urls.iter().zip(links) { | ||||||
| let Some(cap) = ANCHOR_URL.captures(url) else { | ||||||
| let line = super::line_from_range(&chapter.content, &link.range); | ||||||
| // `[!NOTE]` and `[!WARNING]` will be handled by the admonitions | ||||||
| // support upstream | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| let initial_spaces = line.chars().position(|ch| ch != ' ').unwrap_or(0); | ||||||
| let after_spaces = &line[initial_spaces..]; | ||||||
| if after_spaces == "> [!NOTE]" { | ||||||
| continue; | ||||||
| } | ||||||
| if after_spaces == "> [!WARNING]" { | ||||||
| continue; | ||||||
| } | ||||||
|
Comment on lines
+318
to
+323
Contributor
There was a problem hiding this comment. The check here seems a bit fragile; does this match the overall parsing? |
||||||
| warn_or_err!( | ||||||
| diag, | ||||||
| "broken markdown link found in {}\n\ | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the plan is to submit an upstream change to add
EXAMPLEadmonitions there too, we might as well switch this to anEDITION-NNNNadmonition at this point.View changes since the review