Merge pull request #578 from peng1999/master

Add emphasis, strong and code support in header

components/rendering/src/markdown.rs

@@ -49,6 +49,68 @@ fn is_colocated_asset_link(link: &str) -> bool {
         && !link.starts_with("mailto:")
 }
 
+fn fix_link(link: &str, context: &RenderContext) -> Result<String> {
+    // A few situations here:
+    // - it could be a relative link (starting with `./`)
+    // - it could be a link to a co-located asset
+    // - it could be a normal link
+    let result = if link.starts_with("./") {
+        match resolve_internal_link(&link, context.permalinks) {
+            Ok(url) => url,
+            Err(_) => {
+                return Err(format!("Relative link {} not found.", link).into());
+            }
+        }
+    } else if is_colocated_asset_link(&link) {
+        format!("{}{}", context.current_page_permalink, link)
+    } else if context.config.check_external_links
+        && !link.starts_with('#')
+        && !link.starts_with("mailto:") {
+        let res = check_url(&link);
+        if res.is_valid() {
+            link.to_string()
+        } else {
+            return Err(
+                format!("Link {} is not valid: {}", link, res.message()).into(),
+            );
+        }
+    } else {
+        link.to_string()
+    };
+    Ok(result)
+}
+
+fn push_start_tag(temp_header: &mut TempHeader, tag: &Tag) -> bool {
+    match tag {
+        Tag::Emphasis => temp_header.add_html("<em>"),
+        Tag::Strong => temp_header.add_html("<strong>"),
+        Tag::Code => temp_header.add_html("<code>"),
+        // Tag::Link is handled in `markdown_to_html`
+        _ => return false,
+    }
+    true
+}
+
+fn push_end_tag(temp_header: &mut TempHeader, tag: &Tag) -> bool {
+    match tag {
+        Tag::Emphasis => temp_header.add_html("</em>"),
+        Tag::Strong => temp_header.add_html("</strong>"),
+        Tag::Code => temp_header.add_html("</code>"),
+        Tag::Link(_, _) => temp_header.add_html("</a>"),
+        _ => return false,
+    }
+    true
+}
+
+/// returns true if event have been processed
+fn push_to_temp_header(event: &Event, temp_header: &mut TempHeader) -> bool {
+    match event {
+        Event::Start(tag) => push_start_tag(temp_header, tag),
+        Event::End(tag) => push_end_tag(temp_header, tag),
+        _ => false,
+    }
+}
+
 pub fn markdown_to_html(content: &str, context: &RenderContext) -> Result<Rendered> {
     // the rendered html
     let mut html = String::with_capacity(content.len());
@@ -76,6 +138,11 @@ pub fn markdown_to_html(content: &str, context: &RenderContext) -> Result<Render
 
     {
         let parser = Parser::new_ext(content, opts).map(|event| {
+            // if in header, just do the parse ourselves
+            if in_header && push_to_temp_header(&event, &mut temp_header) {
+                return Event::Html(Borrowed(""));
+            }
+
             match event {
                 Event::Text(text) => {
                     // Header first
@@ -142,37 +209,12 @@ pub fn markdown_to_html(content: &str, context: &RenderContext) -> Result<Render
                     Event::Start(Tag::Image(src, title))
                 }
                 Event::Start(Tag::Link(link, title)) => {
-                    // A few situations here:
+                    let fixed_link = match fix_link(&link, context) {
-                    // - it could be a relative link (starting with `./`)
+                        Ok(fixed_link) => fixed_link,
-                    // - it could be a link to a co-located asset
+                        Err(err) => {
-                    // - it could be a normal link
+                            error = Some(err);
-                    // - any of those can be in a header or not: if it's in a header
+                            return Event::Html(Borrowed(""))
-                    //   we need to append to a string
-                    let fixed_link = if link.starts_with("./") {
-                        match resolve_internal_link(&link, context.permalinks) {
-                            Ok(url) => url,
-                            Err(_) => {
-                                error = Some(format!("Relative link {} not found.", link).into());
-                                return Event::Html(Borrowed(""));
-                            }
                         }
-                    } else if is_colocated_asset_link(&link) {
-                        format!("{}{}", context.current_page_permalink, link)
-                    } else if context.config.check_external_links
-                        && !link.starts_with('#')
-                        && !link.starts_with("mailto:")
-                    {
-                        let res = check_url(&link);
-                        if res.is_valid() {
-                            link.to_string()
-                        } else {
-                            error = Some(
-                                format!("Link {} is not valid: {}", link, res.message()).into(),
-                            );
-                            String::new()
-                        }
-                    } else {
-                        link.to_string()
                     };
 
                     if in_header {
@@ -187,27 +229,6 @@ pub fn markdown_to_html(content: &str, context: &RenderContext) -> Result<Render
 
                     Event::Start(Tag::Link(Owned(fixed_link), title))
                 }
-                Event::End(Tag::Link(_, _)) => {
-                    if in_header {
-                        temp_header.add_html("</a>");
-                        return Event::Html(Borrowed(""));
-                    }
-                    event
-                }
-                Event::Start(Tag::Code) => {
-                    if in_header {
-                        temp_header.add_html("<code>");
-                        return Event::Html(Borrowed(""));
-                    }
-                    event
-                }
-                Event::End(Tag::Code) => {
-                    if in_header {
-                        temp_header.add_html("</code>");
-                        return Event::Html(Borrowed(""));
-                    }
-                    event
-                }
                 Event::Start(Tag::Header(num)) => {
                     in_header = true;
                     temp_header = TempHeader::new(num);

components/rendering/tests/markdown.rs

@@ -522,6 +522,33 @@ fn can_understand_link_with_title_in_header() {
     );
 }
 
+#[test]
+fn can_understand_emphasis_in_header() {
+    let permalinks_ctx = HashMap::new();
+    let config = Config::default();
+    let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
+    let res = render_content("# *Emphasis* text", &context).unwrap();
+    assert_eq!(res.body, "<h1 id=\"emphasis-text\"><em>Emphasis</em> text</h1>\n")
+}
+
+#[test]
+fn can_understand_strong_in_header() {
+    let permalinks_ctx = HashMap::new();
+    let config = Config::default();
+    let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
+    let res = render_content("# **Strong** text", &context).unwrap();
+    assert_eq!(res.body, "<h1 id=\"strong-text\"><strong>Strong</strong> text</h1>\n")
+}
+
+#[test]
+fn can_understand_code_in_header() {
+    let permalinks_ctx = HashMap::new();
+    let config = Config::default();
+    let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
+    let res = render_content("# `Code` text", &context).unwrap();
+    assert_eq!(res.body, "<h1 id=\"code-text\"><code>Code</code> text</h1>\n")
+}
+
 #[test]
 fn can_make_valid_relative_link_in_header() {
     let mut permalinks = HashMap::new();