diff options
| author |  Titus Wormer <tituswormer@gmail.com> | 2022-06-22 16:41:04 +0200 |
|---|---|---|
| committer | Titus Wormer <tituswormer@gmail.com> | 2022-06-22 16:41:04 +0200 |
| commit | b0accb11f1aade55e9fc4dc0a1c1d1b8362ab5d9 (patch) | |
| tree | 7137fb206a909feb5c6f841c1a9e3dafc590312c /src/construct/definition.rs | |
| parent | cbd0155d7f1f20b3fe261723515203df5108a56d (diff) | |
| download | markdown-rs-b0accb11f1aade55e9fc4dc0a1c1d1b8362ab5d9.tar.gz markdown-rs-b0accb11f1aade55e9fc4dc0a1c1d1b8362ab5d9.tar.bz2 markdown-rs-b0accb11f1aade55e9fc4dc0a1c1d1b8362ab5d9.zip | |
Add docs on encoding to definition, destination
Diffstat (limited to 'src/construct/definition.rs')
| -rw-r--r-- | src/construct/definition.rs | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/construct/definition.rs b/src/construct/definition.rs index b545643..57c62a5 100644 --- a/src/construct/definition.rs +++ b/src/construct/definition.rs @@ -30,7 +30,7 @@ //! space_or_tab ::= ' ' | '\t' //! ``` //! -//! Definitions in markdown to not, on their own, relate to anything in HTML. +//! Definitions in markdown do not, on their own, relate to anything in HTML. //! When connected with a link (reference), they together relate to the `<a>` //! element in HTML. //! The definition forms its `href`, and optionally `title`, attributes. @@ -41,6 +41,12 @@ //! That means that [character escapes][character_escape] and //! [character references][character_reference] are allowed. //! +//! For info on how to encode characters in URLs, see +//! [`partial_destination`][destination]. +//! For info on how to characters are encoded as `href` on `<a>` or `src` on +//! `<img>` when compiling, see +//! [`sanitize_uri`][sanitize_uri]. +//! //! ## Tokens //! //! * [`Definition`][TokenType::Definition] @@ -68,6 +74,8 @@ //! [string]: crate::content::string //! [character_escape]: crate::construct::character_escape //! [character_reference]: crate::construct::character_reference +//! [destination]: crate::construct::partial_destination +//! [sanitize_uri]: crate::util::sanitize_uri //! [html]: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-a-element //! //! <!-- To do: link link (reference) --> |