aboutsummaryrefslogtreecommitdiffstats
path: root/src/construct/label_start_link.rs
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-28 15:15:26 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-06-28 15:15:26 +0200
commite9db93b428bc3da7c1fa3bcf8acf166012cf18c8 (patch)
treef3998ce57afcd1c148967713899436a4213a6ca7 /src/construct/label_start_link.rs
parent769e7011d37a2ad54630aeebdb0b0163a0825f75 (diff)
downloadmarkdown-rs-e9db93b428bc3da7c1fa3bcf8acf166012cf18c8.tar.gz
markdown-rs-e9db93b428bc3da7c1fa3bcf8acf166012cf18c8.tar.bz2
markdown-rs-e9db93b428bc3da7c1fa3bcf8acf166012cf18c8.zip
Add docs for label start (image, link)
Diffstat (limited to 'src/construct/label_start_link.rs')
-rw-r--r--src/construct/label_start_link.rs30
1 files changed, 29 insertions, 1 deletions
diff --git a/src/construct/label_start_link.rs b/src/construct/label_start_link.rs
index 35c9dcd..677fb50 100644
--- a/src/construct/label_start_link.rs
+++ b/src/construct/label_start_link.rs
@@ -1,4 +1,32 @@
-//! To do
+//! Label start (link) is a construct that occurs in the [text][] content
+//! type.
+//!
+//! It forms with the following BNF:
+//!
+//! ```bnf
+//! label_start_link ::= '['
+//! ```
+//!
+//! Label start (link) relates to the `<a>` element in HTML.
+//! See [*§ 4.5.1 The `a` element*][html-a] in the HTML spec for more info.
+//!
+//! Whether it contributes a link depends on whether it is followed by a
+//! valid [label end][label_end] or not.
+//! Without an end, the characters (`[`) are output.
+//!
+//! ## Tokens
+//!
+//! * [`LabelLink`][TokenType::LabelLink]
+//! * [`LabelMarker`][TokenType::LabelMarker]
+//!
+//! ## References
+//!
+//! * [`label-start-link.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-core-commonmark/dev/lib/label-start-link.js)
+//! * [*§ 6.3 Links* in `CommonMark`](https://spec.commonmark.org/0.30/#links)
+//!
+//! [text]: crate::content::text
+//! [label_end]: crate::construct::label_end
+//! [html-a]: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-a-element
use super::label_end::resolve_media;
use crate::tokenizer::{Code, LabelStart, State, StateFnResult, TokenType, Tokenizer};