Add render option to wrap escaped chars in span #367
Conversation
This allows post-processing filters to know if a character was originally escaped or not. Normally that information is lost.
|
As an aside, I can't believe I didn't think of doing something like this back when I was at GitHub and contending with the exact same problem (then in cmark-gfm) — despite very much wanting to make backslash-escaping of @mentions a possibility, I simply couldn't think of a solution, and so |
|
Thanks! Yeah finally figured out a solution a couple years ago for GitLab, using pre-processing and post-processing filters, but it's a hack. So I'm quite stoked to be able to add this support natively! I just need to add some tests... |
| println!("Original Input:"); | ||
| println!("=============================="); | ||
| println!("{}", original_input); | ||
| println!("=============================="); |
There was a problem hiding this comment.
@kivikakk added this so it's easier to see the original input that caused the error, rather than referring to the actual test.
with cargo run --example update-readme
|
This is fantastic! |
CommonMark supports escaping characters, which short-circuits normal markdown processing for that character.
But normally this information is lost in the final html. Post-processing filters sometimes need this information in order to keep special references from being recognized, such as
@user. Ideally\@usershould keep the reference from being recognized, but the final html only has@user.This PR adds an option
--escaped-char-spansthat will wrap escaped characters in a<span data-escaped-char>. Post-processing filters can then use this when parsing for special references.