Allow manual specification of header IDs (#685)
Justification for this feature is added in the docs.
Precedent for the precise syntax: Hugo.
Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.
My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `}`.
The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.
Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):
- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
“Foo” and ID `*bar*`, since it is working at the source level; whereas
this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
it works at the pulldown-cmark event level and doesn’t go out of its
way to make that work (I’m not familiar with pulldown-cmark, but I get
the impression that you could make it work Hugo’s way on this point).
The difference should be negligible: only *very* esoteric hashes would
include magic Markdown characters.
- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
coded here will yield a blank ID instead (which feels more correct to
me—`None` versus `Some("")`, and all that).
In practice the results should be identical.
Fixes #433.
[0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234 5 years ago Allow manual specification of header IDs (#685)
Justification for this feature is added in the docs.
Precedent for the precise syntax: Hugo.
Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.
My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `}`.
The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.
Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):
- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
“Foo” and ID `*bar*`, since it is working at the source level; whereas
this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
it works at the pulldown-cmark event level and doesn’t go out of its
way to make that work (I’m not familiar with pulldown-cmark, but I get
the impression that you could make it work Hugo’s way on this point).
The difference should be negligible: only *very* esoteric hashes would
include magic Markdown characters.
- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
coded here will yield a blank ID instead (which feels more correct to
me—`None` versus `Some("")`, and all that).
In practice the results should be identical.
Fixes #433.
[0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234 5 years ago Allow manual specification of header IDs (#685)
Justification for this feature is added in the docs.
Precedent for the precise syntax: Hugo.
Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.
My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `}`.
The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.
Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):
- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
“Foo” and ID `*bar*`, since it is working at the source level; whereas
this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
it works at the pulldown-cmark event level and doesn’t go out of its
way to make that work (I’m not familiar with pulldown-cmark, but I get
the impression that you could make it work Hugo’s way on this point).
The difference should be negligible: only *very* esoteric hashes would
include magic Markdown characters.
- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
coded here will yield a blank ID instead (which feels more correct to
me—`None` versus `Some("")`, and all that).
In practice the results should be identical.
Fixes #433.
[0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234 5 years ago Allow manual specification of header IDs (#685)
Justification for this feature is added in the docs.
Precedent for the precise syntax: Hugo.
Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.
My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `}`.
The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.
Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):
- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
“Foo” and ID `*bar*`, since it is working at the source level; whereas
this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
it works at the pulldown-cmark event level and doesn’t go out of its
way to make that work (I’m not familiar with pulldown-cmark, but I get
the impression that you could make it work Hugo’s way on this point).
The difference should be negligible: only *very* esoteric hashes would
include magic Markdown characters.
- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
coded here will yield a blank ID instead (which feels more correct to
me—`None` versus `Some("")`, and all that).
In practice the results should be identical.
Fixes #433.
[0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234 5 years ago Allow manual specification of header IDs (#685)
Justification for this feature is added in the docs.
Precedent for the precise syntax: Hugo.
Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.
My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `}`.
The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.
Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):
- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
“Foo” and ID `*bar*`, since it is working at the source level; whereas
this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
it works at the pulldown-cmark event level and doesn’t go out of its
way to make that work (I’m not familiar with pulldown-cmark, but I get
the impression that you could make it work Hugo’s way on this point).
The difference should be negligible: only *very* esoteric hashes would
include magic Markdown characters.
- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
coded here will yield a blank ID instead (which feels more correct to
me—`None` versus `Some("")`, and all that).
In practice the results should be identical.
Fixes #433.
[0]: https://github.com/russross/blackfriday/blob/a477dd1646916742841ed20379f941cfa6c5bb6f/block.go#L218-L234 5 years ago |
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859 |
- use std::collections::HashMap;
-
- use tera::Tera;
-
- use config::Config;
- use front_matter::InsertAnchor;
- use rendering::{render_content, RenderContext};
- use templates::ZOLA_TERA;
-
- #[test]
- fn can_do_render_content_simple() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("hello", &context).unwrap();
- assert_eq!(res.body, "<p>hello</p>\n");
- }
-
- #[test]
- fn doesnt_highlight_code_block_with_highlighting_off() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let mut config = Config::default();
- config.highlight_code = false;
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("```\n$ gutenberg server\n```", &context).unwrap();
- assert_eq!(res.body, "<pre><code>$ gutenberg server\n</code></pre>\n");
- }
-
- #[test]
- fn can_highlight_code_block_no_lang() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let mut config = Config::default();
- config.highlight_code = true;
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("```\n$ gutenberg server\n$ ping\n```", &context).unwrap();
- assert_eq!(
- res.body,
- "<pre style=\"background-color:#2b303b;\">\n<span style=\"color:#c0c5ce;\">$ gutenberg server\n$ ping\n</span></pre>"
- );
- }
-
- #[test]
- fn can_highlight_code_block_with_lang() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let mut config = Config::default();
- config.highlight_code = true;
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("```python\nlist.append(1)\n```", &context).unwrap();
- assert_eq!(
- res.body,
- "<pre style=\"background-color:#2b303b;\">\n<span style=\"color:#c0c5ce;\">list.</span><span style=\"color:#bf616a;\">append</span><span style=\"color:#c0c5ce;\">(</span><span style=\"color:#d08770;\">1</span><span style=\"color:#c0c5ce;\">)\n</span></pre>"
- );
- }
-
- #[test]
- fn can_higlight_code_block_with_unknown_lang() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let mut config = Config::default();
- config.highlight_code = true;
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("```yolo\nlist.append(1)\n```", &context).unwrap();
- // defaults to plain text
- assert_eq!(
- res.body,
- "<pre style=\"background-color:#2b303b;\">\n<span style=\"color:#c0c5ce;\">list.append(1)\n</span></pre>"
- );
- }
-
- #[test]
- fn can_render_shortcode() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content(
- r#"
- Hello
-
- {{ youtube(id="ub36ffWAqgQ") }}
- "#,
- &context,
- )
- .unwrap();
- assert!(res.body.contains("<p>Hello</p>\n<div >"));
- assert!(res.body.contains(r#"<iframe src="https://www.youtube.com/embed/ub36ffWAqgQ""#));
- }
-
- #[test]
- fn can_render_shortcode_with_markdown_char_in_args_name() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let input = vec!["name", "na_me", "n_a_me", "n1"];
- for i in input {
- let res =
- render_content(&format!("{{{{ youtube(id=\"hey\", {}=1) }}}}", i), &context).unwrap();
- assert!(res.body.contains(r#"<iframe src="https://www.youtube.com/embed/hey""#));
- }
- }
-
- #[test]
- fn can_render_shortcode_with_markdown_char_in_args_value() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let input = vec![
- "ub36ffWAqgQ-hey",
- "ub36ffWAqgQ_hey",
- "ub36ffWAqgQ_he_y",
- "ub36ffWAqgQ*hey",
- "ub36ffWAqgQ#hey",
- ];
- for i in input {
- let res = render_content(&format!("{{{{ youtube(id=\"{}\") }}}}", i), &context).unwrap();
- assert!(res
- .body
- .contains(&format!(r#"<iframe src="https://www.youtube.com/embed/{}""#, i)));
- }
- }
-
- #[test]
- fn can_render_body_shortcode_with_markdown_char_in_name() {
- let permalinks_ctx = HashMap::new();
- let mut tera = Tera::default();
- tera.extend(&ZOLA_TERA).unwrap();
- let input = vec!["quo_te", "qu_o_te"];
- let config = Config::default();
-
- for i in input {
- tera.add_raw_template(
- &format!("shortcodes/{}.html", i),
- "<blockquote>{{ body }} - {{ author}}</blockquote>",
- )
- .unwrap();
- let context = RenderContext::new(&tera, &config, "", &permalinks_ctx, InsertAnchor::None);
-
- let res =
- render_content(&format!("{{% {}(author=\"Bob\") %}}\nhey\n{{% end %}}", i), &context)
- .unwrap();
- println!("{:?}", res);
- assert!(res.body.contains("<blockquote>hey - Bob</blockquote>"));
- }
- }
-
- #[test]
- fn can_render_body_shortcode_and_paragraph_after() {
- let permalinks_ctx = HashMap::new();
- let mut tera = Tera::default();
- tera.extend(&ZOLA_TERA).unwrap();
-
- let shortcode = "<p>{{ body }}</p>";
- let markdown_string = r#"
- {% figure() %}
- This is a figure caption.
- {% end %}
-
- Here is another paragraph.
- "#;
-
- let expected = "<p>This is a figure caption.</p>
- <p>Here is another paragraph.</p>
- ";
-
- tera.add_raw_template(&format!("shortcodes/{}.html", "figure"), shortcode).unwrap();
- let config = Config::default();
- let context = RenderContext::new(&tera, &config, "", &permalinks_ctx, InsertAnchor::None);
-
- let res = render_content(markdown_string, &context).unwrap();
- println!("{:?}", res);
- assert_eq!(res.body, expected);
- }
-
- #[test]
- fn can_render_two_body_shortcode_and_paragraph_after_with_line_break_between() {
- let permalinks_ctx = HashMap::new();
- let mut tera = Tera::default();
- tera.extend(&ZOLA_TERA).unwrap();
-
- let shortcode = "<p>{{ body }}</p>";
- let markdown_string = r#"
- {% figure() %}
- This is a figure caption.
- {% end %}
-
- {% figure() %}
- This is a figure caption.
- {% end %}
-
- Here is another paragraph.
- "#;
-
- let expected = "<p>This is a figure caption.</p>
- <p>This is a figure caption.</p>
- <p>Here is another paragraph.</p>
- ";
-
- tera.add_raw_template(&format!("shortcodes/{}.html", "figure"), shortcode).unwrap();
- let config = Config::default();
- let context = RenderContext::new(&tera, &config, "", &permalinks_ctx, InsertAnchor::None);
-
- let res = render_content(markdown_string, &context).unwrap();
- println!("{:?}", res);
- assert_eq!(res.body, expected);
- }
-
- #[test]
- fn can_render_several_shortcode_in_row() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content(
- r#"
- Hello
-
- {{ youtube(id="ub36ffWAqgQ") }}
-
- {{ youtube(id="ub36ffWAqgQ", autoplay=true) }}
-
- {{ vimeo(id="210073083") }}
-
- {{ streamable(id="c0ic") }}
-
- {{ gist(url="https://gist.github.com/Keats/32d26f699dcc13ebd41b") }}
-
- "#,
- &context,
- )
- .unwrap();
- assert!(res.body.contains("<p>Hello</p>\n<div >"));
- assert!(res.body.contains(r#"<iframe src="https://www.youtube.com/embed/ub36ffWAqgQ""#));
- assert!(res
- .body
- .contains(r#"<iframe src="https://www.youtube.com/embed/ub36ffWAqgQ?autoplay=1""#));
- assert!(res.body.contains(r#"<iframe src="https://www.streamable.com/e/c0ic""#));
- assert!(res.body.contains(r#"//player.vimeo.com/video/210073083""#));
- }
-
- #[test]
- fn doesnt_render_ignored_shortcodes() {
- let permalinks_ctx = HashMap::new();
- let mut config = Config::default();
- config.highlight_code = false;
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content(r#"```{{/* youtube(id="w7Ft2ymGmfc") */}}```"#, &context).unwrap();
- assert_eq!(res.body, "<p><code>{{ youtube(id="w7Ft2ymGmfc") }}</code></p>\n");
- }
-
- #[test]
- fn can_render_shortcode_with_body() {
- let mut tera = Tera::default();
- tera.extend(&ZOLA_TERA).unwrap();
- tera.add_raw_template(
- "shortcodes/quote.html",
- "<blockquote>{{ body }} - {{ author }}</blockquote>",
- )
- .unwrap();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera, &config, "", &permalinks_ctx, InsertAnchor::None);
-
- let res = render_content(
- r#"
- Hello
- {% quote(author="Keats") %}
- A quote
- {% end %}
- "#,
- &context,
- )
- .unwrap();
- assert_eq!(res.body, "<p>Hello</p>\n<blockquote>A quote - Keats</blockquote>\n");
- }
-
- #[test]
- fn errors_rendering_unknown_shortcode() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("{{ hello(flash=true) }}", &context);
- assert!(res.is_err());
- }
-
- #[test]
- fn can_make_valid_relative_link() {
- let mut permalinks = HashMap::new();
- permalinks.insert("pages/about.md".to_string(), "https://vincent.is/about".to_string());
- let tera_ctx = Tera::default();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks, InsertAnchor::None);
- let res = render_content(
- r#"[rel link](@/pages/about.md), [abs link](https://vincent.is/about)"#,
- &context,
- )
- .unwrap();
-
- assert!(
- res.body.contains(r#"<p><a href="https://vincent.is/about">rel link</a>, <a href="https://vincent.is/about">abs link</a></p>"#)
- );
- }
-
- #[test]
- fn can_make_relative_links_with_anchors() {
- let mut permalinks = HashMap::new();
- permalinks.insert("pages/about.md".to_string(), "https://vincent.is/about".to_string());
- let tera_ctx = Tera::default();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks, InsertAnchor::None);
- let res = render_content(r#"[rel link](@/pages/about.md#cv)"#, &context).unwrap();
-
- assert!(res.body.contains(r#"<p><a href="https://vincent.is/about#cv">rel link</a></p>"#));
- }
-
- #[test]
- fn errors_relative_link_inexistant() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("[rel link](@/pages/about.md)", &context);
- assert!(res.is_err());
- }
-
- #[test]
- fn can_add_id_to_headings() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content(r#"# Hello"#, &context).unwrap();
- assert_eq!(res.body, "<h1 id=\"hello\">Hello</h1>\n");
- }
-
- #[test]
- fn can_add_id_to_headings_same_slug() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("# Hello\n# Hello", &context).unwrap();
- assert_eq!(res.body, "<h1 id=\"hello\">Hello</h1>\n<h1 id=\"hello-1\">Hello</h1>\n");
- }
-
- #[test]
- fn can_add_non_slug_id_to_headings() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let mut config = Config::default();
- config.slugify_paths = false;
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content(r#"# L'écologie et vous"#, &context).unwrap();
- assert_eq!(res.body, "<h1 id=\"L'écologie_et_vous\">L'écologie et vous</h1>\n");
- }
-
- #[test]
- fn can_handle_manual_ids_on_headings() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- // Tested things: manual IDs; whitespace flexibility; that automatic IDs avoid collision with
- // manual IDs; that duplicates are in fact permitted among manual IDs; that any non-plain-text
- // in the middle of `{#…}` will disrupt it from being acknowledged as a manual ID (that last
- // one could reasonably be considered a bug rather than a feature, but test it either way); one
- // workaround for the improbable case where you actually want `{#…}` at the end of a heading.
- let res = render_content(
- "\
- # Hello\n\
- # Hello{#hello}\n\
- # Hello {#hello}\n\
- # Hello {#Something_else} \n\
- # Workaround for literal {#…}\n\
- # Hello\n\
- # Auto {#*matic*}",
- &context,
- )
- .unwrap();
- assert_eq!(
- res.body,
- "\
- <h1 id=\"hello-1\">Hello</h1>\n\
- <h1 id=\"hello\">Hello</h1>\n\
- <h1 id=\"hello\">Hello</h1>\n\
- <h1 id=\"Something_else\">Hello</h1>\n\
- <h1 id=\"workaround-for-literal\">Workaround for literal {#…}</h1>\n\
- <h1 id=\"hello-2\">Hello</h1>\n\
- <h1 id=\"auto-matic\">Auto {#<em>matic</em>}</h1>\n\
- "
- );
- }
-
- #[test]
- fn blank_headings() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("# \n#\n# {#hmm} \n# {#}", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"-1\"></h1>\n<h1 id=\"-2\"></h1>\n<h1 id=\"hmm\"></h1>\n<h1 id=\"\"></h1>\n"
- );
- }
-
- #[test]
- fn can_insert_anchor_left() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::Left);
- let res = render_content("# Hello", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"hello\"><a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a>Hello</h1>\n"
- );
- }
-
- #[test]
- fn can_insert_anchor_right() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::Right);
- let res = render_content("# Hello", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"hello\">Hello<a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a></h1>\n"
- );
- }
-
- #[test]
- fn can_insert_anchor_for_multi_heading() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::Right);
- let res = render_content("# Hello\n# World", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"hello\">Hello<a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a></h1>\n\
- <h1 id=\"world\">World<a class=\"zola-anchor\" href=\"#world\" aria-label=\"Anchor link for: world\">🔗</a></h1>\n"
- );
- }
-
- // See https://github.com/Keats/gutenberg/issues/42
- #[test]
- fn can_insert_anchor_with_exclamation_mark() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::Left);
- let res = render_content("# Hello!", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"hello\"><a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a>Hello!</h1>\n"
- );
- }
-
- // See https://github.com/Keats/gutenberg/issues/53
- #[test]
- fn can_insert_anchor_with_link() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::Left);
- let res = render_content("## [Rust](https://rust-lang.org)", &context).unwrap();
- assert_eq!(
- res.body,
- "<h2 id=\"rust\"><a class=\"zola-anchor\" href=\"#rust\" aria-label=\"Anchor link for: rust\">🔗</a><a href=\"https://rust-lang.org\">Rust</a></h2>\n"
- );
- }
-
- #[test]
- fn can_insert_anchor_with_other_special_chars() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::Left);
- let res = render_content("# Hello*_()", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"hello\"><a class=\"zola-anchor\" href=\"#hello\" aria-label=\"Anchor link for: hello\">🔗</a>Hello*_()</h1>\n"
- );
- }
-
- #[test]
- fn can_make_toc() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(
- &ZOLA_TERA,
- &config,
- "https://mysite.com/something",
- &permalinks_ctx,
- InsertAnchor::Left,
- );
-
- let res = render_content(
- r#"
- # Heading 1
-
- ## Heading 2
-
- ## Another Heading 2
-
- ### Last one
- "#,
- &context,
- )
- .unwrap();
-
- let toc = res.toc;
- assert_eq!(toc.len(), 1);
- assert_eq!(toc[0].children.len(), 2);
- assert_eq!(toc[0].children[1].children.len(), 1);
- }
-
- #[test]
- fn can_ignore_tags_in_toc() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(
- &ZOLA_TERA,
- &config,
- "https://mysite.com/something",
- &permalinks_ctx,
- InsertAnchor::Left,
- );
-
- let res = render_content(
- r#"
- ## heading with `code`
-
- ## [anchor](https://duckduckgo.com/) in heading
-
- ## **bold** and *italics*
- "#,
- &context,
- )
- .unwrap();
-
- let toc = res.toc;
-
- assert_eq!(toc[0].id, "heading-with-code");
- assert_eq!(toc[0].title, "heading with code");
-
- assert_eq!(toc[1].id, "anchor-in-heading");
- assert_eq!(toc[1].title, "anchor in heading");
-
- assert_eq!(toc[2].id, "bold-and-italics");
- assert_eq!(toc[2].title, "bold and italics");
- }
-
- #[test]
- fn can_understand_backtick_in_titles() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("# `Hello`", &context).unwrap();
- assert_eq!(res.body, "<h1 id=\"hello\"><code>Hello</code></h1>\n");
- }
-
- #[test]
- fn can_understand_backtick_in_paragraphs() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("Hello `world`", &context).unwrap();
- assert_eq!(res.body, "<p>Hello <code>world</code></p>\n");
- }
-
- // https://github.com/Keats/gutenberg/issues/297
- #[test]
- fn can_understand_links_in_heading() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("# [Rust](https://rust-lang.org)", &context).unwrap();
- assert_eq!(res.body, "<h1 id=\"rust\"><a href=\"https://rust-lang.org\">Rust</a></h1>\n");
- }
-
- #[test]
- fn can_understand_link_with_title_in_heading() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res =
- render_content("# [Rust](https://rust-lang.org \"Rust homepage\")", &context).unwrap();
- assert_eq!(
- res.body,
- "<h1 id=\"rust\"><a href=\"https://rust-lang.org\" title=\"Rust homepage\">Rust</a></h1>\n"
- );
- }
-
- #[test]
- fn can_understand_emphasis_in_heading() {
- 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_heading() {
- 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_heading() {
- 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");
- }
-
- // See https://github.com/getzola/zola/issues/569
- #[test]
- fn can_understand_footnote_in_heading() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&ZOLA_TERA, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content("# text [^1] there\n[^1]: footnote", &context).unwrap();
- assert_eq!(res.body, r##"<h1 id="text-there">text <sup class="footnote-reference"><a href="#1">1</a></sup> there</h1>
- <div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>
- <p>footnote</p>
- </div>
- "##);
- }
-
- #[test]
- fn can_make_valid_relative_link_in_heading() {
- let mut permalinks = HashMap::new();
- permalinks.insert("pages/about.md".to_string(), "https://vincent.is/about/".to_string());
- let tera_ctx = Tera::default();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks, InsertAnchor::None);
- let res = render_content(r#" # [rel link](@/pages/about.md)"#, &context).unwrap();
-
- assert_eq!(
- res.body,
- "<h1 id=\"rel-link\"><a href=\"https://vincent.is/about/\">rel link</a></h1>\n"
- );
- }
-
- #[test]
- fn can_make_permalinks_with_colocated_assets_for_link() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(
- &ZOLA_TERA,
- &config,
- "https://vincent.is/about/",
- &permalinks_ctx,
- InsertAnchor::None,
- );
- let res = render_content("[an image](image.jpg)", &context).unwrap();
- assert_eq!(res.body, "<p><a href=\"https://vincent.is/about/image.jpg\">an image</a></p>\n");
- }
-
- #[test]
- fn can_make_permalinks_with_colocated_assets_for_image() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(
- &ZOLA_TERA,
- &config,
- "https://vincent.is/about/",
- &permalinks_ctx,
- InsertAnchor::None,
- );
- let res = render_content("![alt text](image.jpg)", &context).unwrap();
- assert_eq!(
- res.body,
- "<p><img src=\"https://vincent.is/about/image.jpg\" alt=\"alt text\" /></p>\n"
- );
- }
-
- #[test]
- fn markdown_doesnt_wrap_html_in_paragraph() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(
- &ZOLA_TERA,
- &config,
- "https://vincent.is/about/",
- &permalinks_ctx,
- InsertAnchor::None,
- );
- let res = render_content(
- r#"
- Some text
-
- <h1>Helo</h1>
-
- <div>
- <a href="mobx-flow.png">
- <img src="mobx-flow.png" alt="MobX flow">
- </a>
- </div>
- "#,
- &context,
- )
- .unwrap();
- assert_eq!(
- res.body,
- "<p>Some text</p>\n<h1>Helo</h1>\n<div>\n<a href=\"mobx-flow.png\">\n <img src=\"mobx-flow.png\" alt=\"MobX flow\">\n </a>\n</div>\n"
- );
- }
-
- #[test]
- fn correctly_captures_external_links() {
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(
- &ZOLA_TERA,
- &config,
- "https://vincent.is/about/",
- &permalinks_ctx,
- InsertAnchor::None,
- );
- let content = "
- [a link](http://google.com)
- [a link](http://google.comy)
- Email: [foo@bar.baz](mailto:foo@bar.baz)
- Email: <foo@bar.baz>
- ";
- let res = render_content(content, &context).unwrap();
- assert_eq!(
- res.external_links,
- &["http://google.com".to_owned(), "http://google.comy".to_owned()]
- );
- }
-
- #[test]
- fn can_handle_summaries() {
- let tera_ctx = Tera::default();
- let permalinks_ctx = HashMap::new();
- let config = Config::default();
- let context = RenderContext::new(&tera_ctx, &config, "", &permalinks_ctx, InsertAnchor::None);
- let res = render_content(
- r#"
- Hello [My site][world]
-
- <!-- more -->
-
- Bla bla
-
- [world]: https://vincentprouillet.com
- "#,
- &context,
- )
- .unwrap();
- assert_eq!(
- res.body,
- "<p>Hello <a href=\"https://vincentprouillet.com\">My site</a></p>\n<p id=\"zola-continue-reading\"><a name=\"continue-reading\"></a></p>\n<p>Bla bla</p>\n"
- );
- assert_eq!(
- res.summary_len,
- Some("<p>Hello <a href=\"https://vincentprouillet.com/\">My site</a></p>".len())
- );
- }
-
- // https://github.com/Keats/gutenberg/issues/522
- #[test]
- fn doesnt_try_to_highlight_content_from_shortcode() {
- let permalinks_ctx = HashMap::new();
- let mut tera = Tera::default();
- tera.extend(&ZOLA_TERA).unwrap();
-
- let shortcode = r#"
- <figure>
- {% if width %}
- <img src="/images/{{ src }}" alt="{{ caption }}" width="{{ width }}" />
- {% else %}
- <img src="/images/{{ src }}" alt="{{ caption }}" />
- {% endif %}
-
- <figcaption>{{ caption }}</figcaption>
- </figure>"#;
-
- let markdown_string = r#"{{ figure(src="spherecluster.png", caption="Some spheres.") }}"#;
-
- let expected = r#"<figure>
- <img src="/images/spherecluster.png" alt="Some spheres." />
- <figcaption>Some spheres.</figcaption>
- </figure>"#;
-
- tera.add_raw_template(&format!("shortcodes/{}.html", "figure"), shortcode).unwrap();
- let config = Config::default();
- let context = RenderContext::new(&tera, &config, "", &permalinks_ctx, InsertAnchor::None);
-
- let res = render_content(markdown_string, &context).unwrap();
- assert_eq!(res.body, expected);
- }
-
- // TODO: re-enable once it's fixed in Tera
- // https://github.com/Keats/tera/issues/373
- //#[test]
- //fn can_split_lines_shortcode_body() {
- // let permalinks_ctx = HashMap::new();
- // let mut tera = Tera::default();
- // tera.extend(&ZOLA_TERA).unwrap();
- //
- // let shortcode = r#"{{ body | split(pat="\n") }}"#;
- //
- // let markdown_string = r#"
- //{% alert() %}
- //multi
- //ple
- //lines
- //{% end %}
- // "#;
- //
- // let expected = r#"<p>["multi", "ple", "lines"]</p>"#;
- //
- // tera.add_raw_template(&format!("shortcodes/{}.html", "alert"), shortcode).unwrap();
- // let config = Config::default();
- // let context = RenderContext::new(&tera, &config, "", &permalinks_ctx, InsertAnchor::None);
- //
- // let res = render_content(markdown_string, &context).unwrap();
- // assert_eq!(res.body, expected);
- //}
-
- // https://github.com/getzola/zola/issues/747
- // https://github.com/getzola/zola/issues/816
- #[test]
- fn leaves_custom_url_scheme_untouched() {
- let content = r#"[foo@bar.tld](xmpp:foo@bar.tld)
-
- [(123) 456-7890](tel:+11234567890)
-
- [blank page](about:blank)
- "#;
-
- let tera_ctx = Tera::default();
- let config = Config::default();
- let permalinks_ctx = HashMap::new();
-
- let context = RenderContext::new(
- &tera_ctx,
- &config,
- "https://vincent.is/",
- &permalinks_ctx,
- InsertAnchor::None,
- );
-
- let res = render_content(content, &context).unwrap();
-
- let expected = r#"<p><a href="xmpp:foo@bar.tld">foo@bar.tld</a></p>
- <p><a href="tel:+11234567890">(123) 456-7890</a></p>
- <p><a href="about:blank">blank page</a></p>
- "#;
-
- assert_eq!(res.body, expected);
- }
|