diff options
| author |  Titus Wormer <tituswormer@gmail.com> | 2022-06-15 19:28:54 +0200 |
|---|---|---|
| committer | Titus Wormer <tituswormer@gmail.com> | 2022-06-15 19:28:54 +0200 |
| commit | 7875ada79cea1194dc9e15acee36ed0700be70e6 (patch) | |
| tree | f9d5b82ac92a07a3ff1d05401446dd84bc24d6a7 /src/construct | |
| parent | b150a72975d6e75b96298b3d405afe070271d78b (diff) | |
| download | markdown-rs-7875ada79cea1194dc9e15acee36ed0700be70e6.tar.gz markdown-rs-7875ada79cea1194dc9e15acee36ed0700be70e6.tar.bz2 markdown-rs-7875ada79cea1194dc9e15acee36ed0700be70e6.zip | |
Add docs on sanitizing urls to autolink
Diffstat (limited to '')
| -rw-r--r-- | src/construct/autolink.rs | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/construct/autolink.rs b/src/construct/autolink.rs index 2682878..78003fb 100644 --- a/src/construct/autolink.rs +++ b/src/construct/autolink.rs @@ -38,6 +38,23 @@ //! <p><a href="https://example.com/alpha%20bravo">https://example.com/alpha%20bravo</a></p> //! ``` //! +//! There are several cases where incorrect encoding of URLs would, in other +//! languages, result in a parse error. +//! In markdown, there are no errors, and URLs are normalized. +//! In addition, unicode characters are percent encoded +//! ([`sanitize_uri`][sanitize_uri]). +//! For example: +//! +//! ```markdown +//! <https://a👍b%> +//! ``` +//! +//! Yields: +//! +//! ```html +//! <p><a href="https://a%F0%9F%91%8Db%25">https://a👍b%</a></p> +//! ``` +//! //! Interestingly, there are a couple of things that are valid autolinks in //! markdown but in HTML would be valid tags, such as `<svg:rect>` and //! `<xml:lang/>`. @@ -73,6 +90,7 @@ //! [text]: crate::content::text //! [autolink_scheme_size_max]: crate::constant::AUTOLINK_SCHEME_SIZE_MAX //! [autolink_domain_size_max]: crate::constant::AUTOLINK_DOMAIN_SIZE_MAX +//! [sanitize_uri]: crate::util::sanitize_uri //! [html-a]: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-a-element //! //! <!-- To do: add explanation of sanitation. --> |