0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in `<pre><code>` #6553

divinerites · 2019-11-28T13:35:48Z

What version of Hugo are you using (`hugo version`)?

$ hugo version
Hugo Static Site Generator v0.60.0/extended darwin/amd64 BuildDate: unknown

Does this issue reproduce with the latest release?

Yes. In lates 0.60.0 using goldmark

Following this discourse discussion, confirmed by @onedrawingperday , I fill a bug here
Using indentation in partial/shortcode (inline or classic) causes the HTML to be wrapped in code blocks
Option [markup.goldmark.renderer] unsafe = true has no effect.

The text was updated successfully, but these errors were encountered:

bep · 2019-11-28T13:46:55Z

https://commonmark.org/help/tutorial/09-code.html

divinerites · 2019-11-28T13:55:54Z

Yes, I can understand that indenting with 4 spaces means a code block. No problem.

But I was not expecting that pure HTML/Go-template would be treated like this (it was not with blackFriday).

So, If i read between lines :-) this means that goldmark will treat every 4 spaces as a code block, even for HTML.

So a good prevention measure would be to change "tab->number of space" default in my editor (VSCode) to 3 (at least not 4).

Will look if it changes things. Thanks.

divinerites · 2019-11-28T14:51:33Z

Done some testing with 3 spaces.

If there is strictly 3 spaces as indentation, the result is OK : HTML is written as is.
At the moment where i do 2 indentations (2 x 3) => same problem than before

So I guess that at the moment any HTML code with several indentations (not equal to 3 exactly) will have a problem.
I'll keep testing.

divinerites · 2019-11-28T15:23:09Z

So, after testing a bit I can confirm that :

HTML in a shortcode (inline or called via a partial) is processed by goldmark as if it was markdown.
So if you have ONE indentation of 3 (less than 4) space, it works as HTML. As before.
If you have 4 or more spaces (for ex 3+3 or 3+3+3) it is processed by goldmark and identify and rendered as code block.

I understand that Bep was not surprised by this behaviour, which is fine by me if it is expected behaviour.
But I found this quite surprising because i would never expect HTML being impacted by indentation.

Workaround is to flat your HTML code if it could be called by shortcode. Not read friendly but efficient.

cc @onedrawingperday who helped me a lot on this diagnostic.

bep · 2019-11-28T17:16:45Z

OK, that seems to be a bug in Goldmark. I will create a bug report over there.

I understand that Bep was not surprised by this behaviour,

I didn't say I wasnt surprised, I just pointed to a possible explanation.

bep · 2019-11-28T17:42:24Z

OK; I had a look at this and I don't understand it. The example shows an inline shortcode using {{< which Goldmark should never see. I could understand it if the {{< was indented 4 chars, but that isn't the case. I tested some variants of this myself, and cannot reproduce.

jensamunch · 2019-11-28T17:58:00Z

Hi @bep - I'm not sure this should be closed.
#6552

I made a screencast I think you might enjoy. Headless only works when the folder name does NOT match the name I'm calling it with 🤯

https://youtu.be/pRznYM-3Itk

divinerites · 2019-11-29T11:30:54Z

Later today, I'll provide access to the repo and prepare 3 pages with 3 different shortcodes/partials with this problem. Stay tuned.

divinerites · 2019-11-29T16:47:26Z

Bep & MooreReason, I invited you to the repo.

Use "Migration-en-goldmark" branch.
post vintage.fr.md is working fine (partial is flat HTML)
post test1.fr.md has problem (partial is fully indented HTML)
post test2.fr.md has same problem but different layout because indented a bit differently

First : thanks for your help, and let me know if I can do/test other things.

You can see the 3 post with exactly same code except HTML indentation on the 3 last post here : https://migration-en-goldmark--lagouille.netlify.com/dernieres-nouveautes/

divinerites · 2019-11-29T16:57:30Z

And test1/test2.html have 3 space indentation, and still get the problem. Mmmmmmmm

moorereason · 2019-11-29T18:53:07Z

@divinerites,
Your issue appears to be related to the use of {{ .Content | markdownify }} in layouts/_default/single.html.

divinerites · 2019-11-29T20:30:15Z

Ahhhh. Yes makes sense. Thanks a lot. I Will take this in account.

So as the behaviour was different with use of blackFriday in 0.59.x, will look forward to see if this is expected behaviour or not and then change my code accordingly to the right practice.
But anyhow i DO thanks you a lot for founding a "reasonable" cause & explanation :-). Thanks.

XhmikosR · 2019-12-02T10:37:11Z

I think this is the issue I'm hitting in Bootstrap too after updating Hugo.

This worked fine before but now renders invalid HTML:

<div class="bd-example">
  <table class="table">
    <thead>
      <tr>
        <th scope="col">Class</th>
        <th scope="col">Heading</th>
        <th scope="col">Heading</th>
      </tr>
    </thead>
    <tbody>
      <tr class="table-active">
        <th scope="row">Active</th>
        <td>Cell</td>
        <td>Cell</td>
      </tr>
      <tr>
        <th scope="row">Default</th>
        <td>Cell</td>
        <td>Cell</td>
      </tr>

      {{< table.inline >}}
      {{- range (index $.Site.Data "theme-colors") }}
      <tr class="table-{{ .name }}">
        <th scope="row">{{ .name | title }}</th>
        <td>Cell</td>
        <td>Cell</td>
      </tr>
      {{- end -}}
      {{< /table.inline >}}
    </tbody>
  </table>
</div>

ahmetb · 2019-12-02T21:45:03Z

Also hitting this after updating to v0.60.0. If you use {% %} syntax while invoking shortcodes, HTML tags inside the shortcodes are stripped off.

For example, shortcodes/details.html:

<details>
<summary>{{with .Get "title" }}{{.}}{{else}}Click to expand{{end}}</summary>
{{.Inner}}
</details>

Usage:

{{% details title="foo" %}}
bar
{{% /details %}}

Generated HTML Output:

<p>foo</p>
<!-- raw HTML omitted -->
<p>hello world</p>
<!-- raw HTML omitted -->

moorereason · 2019-12-02T21:54:01Z

@XhmikosR, how does that render?

@ahmetb, are you enabling unsafe in Goldmark?

XhmikosR · 2019-12-02T21:56:02Z

@moorereason <pre><code> inside the HTML with unclosed div tags. I'll be able to provide the exact snippet tomorrow since for now I just reduced indentation to work around this issue https://github.com/twbs/bootstrap/pull/29750/files#diff-dcbb1aeb2504a4b02de5c00ba0296ceb

ahmetb · 2019-12-02T23:47:52Z

@ahmetb, are you enabling unsafe in Goldmark?

First time I'm hearing about Goldmark and the goldmark: configuration.

I don't have markdown: key in my config.yaml and actually things work fine when I downgrade to v0.59.1. Was I relying on undocumenting behavior previously?

ahmetb · 2019-12-02T23:49:07Z

...to add to my previous comment:

I did not realize Blackfriday was replaced with Goldmark.

My Blackfriday config also did not have any relevant keys with respect to unsafe html.

* Fix commonmark syntax related gohugoio/hugo#6553 * Fix indentation Co-authored-by: XhmikosR <xhmikosr@gmail.com>

jmooring · 2021-03-26T21:11:01Z

Closing. The only way to reproduce the original problem is by erroneously piping .Content through markdownify as noted by @moorereason in #6553 (comment).

Simplified test site:

git clone --single-branch -b hugo-github-issue-6553 https://github.com/jmooring/hugo-testing hugo-github-issue-6553
cd hugo-github-issue-6553
hugo server

github-actions · 2022-01-22T01:49:39Z

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

divinerites mentioned this issue Nov 28, 2019

Regression in 0.60.0 for $headless ? #6552

Closed

bep added this to the v0.60.1 milestone Nov 28, 2019

bep added Bug Upstream labels Nov 28, 2019

bep added the NeedsInvestigation label Nov 28, 2019

bep removed the Bug label Nov 29, 2019

bep modified the milestones: v0.60.1, v0.61 Nov 29, 2019

jeremyf mentioned this issue Dec 2, 2019

0.60.1 Goldmark issue regarding markdown and shortcodes #6573

Closed

panda-z mentioned this issue Dec 4, 2019

shortcode失效 olOwOlo/hugo-theme-even#220

Closed

iu4u57k3 mentioned this issue Dec 10, 2019

Indentation in .html and .gohtml shortcodes are outputed as code blocks #6599

Closed

bep removed this from the v0.61 milestone Dec 11, 2019

bep modified the milestones: v0.67, v0.68 Mar 9, 2020

XhmikosR added a commit to twbs/bootstrap that referenced this issue Mar 19, 2020

Fix commonmark syntax (#30276)

a523caa

* Fix commonmark syntax related gohugoio/hugo#6553 * Fix indentation Co-authored-by: XhmikosR <xhmikosr@gmail.com>

bep modified the milestones: v0.68, v0.69 Mar 20, 2020

bep modified the milestones: v0.69, v0.70 Apr 8, 2020

bep modified the milestones: v0.70, v0.71 Apr 28, 2020

bep modified the milestones: v0.71, v0.72 May 18, 2020

bep modified the milestones: v0.72, v0.73 May 31, 2020

bep modified the milestones: v0.73, v0.74 Jun 23, 2020

bep modified the milestones: v0.74, v0.75 Jul 13, 2020

shaform mentioned this issue Aug 26, 2020

#305 Use hugo v0.60 or later, bug fix for shortcodes xianmin/hugo-theme-jane#306

Merged

bep modified the milestones: v0.75, v0.76 Sep 14, 2020

olsza pushed a commit to olsza/bootstrap that referenced this issue Oct 3, 2020

Fix commonmark syntax (twbs#30276)

cda3667

* Fix commonmark syntax related gohugoio/hugo#6553 * Fix indentation Co-authored-by: XhmikosR <xhmikosr@gmail.com>

bep modified the milestones: v0.76, v0.77 Oct 6, 2020

bep modified the milestones: v0.77, v0.78 Oct 30, 2020

jmooring closed this as completed Mar 26, 2021

github-actions bot added the Outdated label Jan 22, 2022

github-actions bot locked as resolved and limited conversation to collaborators Jan 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in `<pre><code>` #6553

0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in `<pre><code>` #6553

divinerites commented Nov 28, 2019 •

edited

Loading

bep commented Nov 28, 2019

divinerites commented Nov 28, 2019 •

edited

Loading

divinerites commented Nov 28, 2019

divinerites commented Nov 28, 2019

bep commented Nov 28, 2019 •

edited

Loading

bep commented Nov 28, 2019

jensamunch commented Nov 28, 2019

divinerites commented Nov 29, 2019

divinerites commented Nov 29, 2019 •

edited

Loading

divinerites commented Nov 29, 2019

moorereason commented Nov 29, 2019

divinerites commented Nov 29, 2019

XhmikosR commented Dec 2, 2019

ahmetb commented Dec 2, 2019

moorereason commented Dec 2, 2019

XhmikosR commented Dec 2, 2019

ahmetb commented Dec 2, 2019 •

edited

Loading

ahmetb commented Dec 2, 2019

jmooring commented Mar 26, 2021

github-actions bot commented Jan 22, 2022

0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in <pre><code> #6553

0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in <pre><code> #6553

Comments

divinerites commented Nov 28, 2019 • edited Loading

What version of Hugo are you using (hugo version)?

Does this issue reproduce with the latest release?

bep commented Nov 28, 2019

divinerites commented Nov 28, 2019 • edited Loading

divinerites commented Nov 28, 2019

divinerites commented Nov 28, 2019

bep commented Nov 28, 2019 • edited Loading

bep commented Nov 28, 2019

jensamunch commented Nov 28, 2019

divinerites commented Nov 29, 2019

divinerites commented Nov 29, 2019 • edited Loading

divinerites commented Nov 29, 2019

moorereason commented Nov 29, 2019

divinerites commented Nov 29, 2019

XhmikosR commented Dec 2, 2019

ahmetb commented Dec 2, 2019

moorereason commented Dec 2, 2019

XhmikosR commented Dec 2, 2019

ahmetb commented Dec 2, 2019 • edited Loading

ahmetb commented Dec 2, 2019

jmooring commented Mar 26, 2021

github-actions bot commented Jan 22, 2022

0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in `<pre><code>` #6553

0.60.0 goldmark: <html> indentation in partial/shortcode wrapped in `<pre><code>` #6553

divinerites commented Nov 28, 2019 •

edited

Loading

What version of Hugo are you using (`hugo version`)?

divinerites commented Nov 28, 2019 •

edited

Loading

bep commented Nov 28, 2019 •

edited

Loading

divinerites commented Nov 29, 2019 •

edited

Loading

ahmetb commented Dec 2, 2019 •

edited

Loading