Create simple shortcode to prevent markdown from rendering HTML

support
1

Hi,
Is there a shortcode I could put in a markdown file that very simply tells Hugo not to render any of the HTML inside it? Like:

+++
front matter
+++
<shortcode>
a bunch of html that should be completely untouched by the markdown rendering engine
</shortcode>

this markdown content would be rendered normally

Why?

Even though Markdown does a pretty good job not messing up HTML, it always seems to a little, and that gets in the way of a fast workflow.

This shortcode might be one half of a simple solution to the questions about (a) creating static content that can use partials and (b) creating nested, multi-level sites… I think if this works the matter will simply be a technique and no changes to Hugo would be necessary. I’ll write it up if I can make it work.

Thank you!

2

Will {< … >} work for you?

3

Sorry…can you be more specific? Is that what goes in the shortcode file?

4

Whether or not a shortcode is used, it looks like when you put HTML in a markdown file it surrounds it with <p>…</p>. So this is another problem to overcome if the goal is to put content in content files and not store it in layouts (which seems like a worthy goal to me).

5

I mistyped the shortcode, but it doesn’t matter. It gets wrapped as you say.

$ cat content/post/first.md
+++
date = "2015-02-24T23:14:31-06:00"
title = "first"
+++
{{< besafe >}}<h5>Hello <strong>World!</strong></h5>{{< /besafe >}}

$ cat layouts/shortcodes/besafe.html 
{{ .Inner }}

$ hugo server --watch

Produces

<!DOCTYPE html>
<html>
<title>first</title>
<body>
<p><h5>Hello <strong>World!</strong></h5>
</p>

<p><a href="/">Home</a></p>
</body>
</html>

Instead of the desired

<!DOCTYPE html>
<html>
<title>first</title>
<body>
<h5>Hello <strong>World!</strong></h5>

<p><a href="/">Home</a></p>
</body>
</html>
6

After looking through Blackfriday, which is the Markdown engine Hugo is using, I’m not sure that I’m answering the right question.

Inline HTML seems to be handled naturally in the Markdown file:

$ cat content/post/first.md
+++
date = "2015-02-24T23:14:31-06:00"
title = "first"
+++

<h5>Hello <strong>World!</strong></h5>

$ hugo

$ cat public/post/first/index.html
<!DOCTYPE html>
<html>
<title>first</title>
<body>

<h5>Hello <strong>World!</strong></h5>

<p><a href="/">Home</a></p>
</body>
</html>

You’ve found cases where that’s not working as you’d expect? What’s the input and output look like?

7

Yes - I found when I put in raw HTML, I occasionally get issues like the extra P tags and all of the comments in my HTML code come through lookling like <!-- comment -->. Which is strange because right here in the box I’m typing in right now, if I type <!-- comment --> it’s invisible, the way it should be. The markdown rendering engine on this site is different from Black Friday I suppose?

In terms of markdown adding the extra P tags, I see there’s a lot of discussion about it, not sure if it’s a bug or feature.

8

Also - big find - if I just change my markdown file to have an HTML file extension, Hugo doesn’t touch the HTML!! And it still passes the HTML to a template for inclusion and still honors the front matter which is where I can tell it what template to use. This is very cool and might be the solution.

I’ll just rename the content files that need to have a lot of HTML in them to filename.html.

Do you know if this is intended behavior (i.e., won’t be changed? ) Really hope so.

9

Mixins have been brought up a few times. I can’t find a recent thread, so I can’t confirm or deny.

10

Yeah the commenting behavior is very strange in Black Friday , definitely beyond my ability to see the logic, unless it’s buggy. I created a comment at the top of some HTML code in a Mardown file and it was rendered invisible, then put the same at the bottom and suddenly now both comments show up in the rendered HTML as <!-- comment -->.

11

It is the intended behavior. We should document it better, but HTML is a supported markup language.
Best,Steve

Steve Francia
http://stevefrancia.comhttp://spf13.comhttp://twitter.com/spf13

12

That is great news, thank you. Being able to have content files be HTML, and have Hugo not touch the HTML, would seem to solve all of the questions related to multi-level sites, static content with partials, homepage template behavior in other places, etc. I can write this up if you think it needs to be made clear? Or, it could be that I’m just late to the party :slight_smile:

13

The whole community would benefit from your contribution

Steve Franciaspf13.com@spf13

14

Do you use the Goldmark markdown handler? Have you tried the unsafe = true configuration option?

See Configure Markup | Hugo

15

You’re bumping a topic that is 7 years old?