Update shortcode docs vs 0.55

This commit is contained in:
Bjørn Erik Pedersen 2019-04-18 09:58:51 +02:00
parent 9a7e192314
commit 13097daf2e
No known key found for this signature in database
GPG Key ID: 330E6E2BD4859D8F

View File

@ -53,12 +53,15 @@ The examples above use two different delimiters, the difference being the `%` ch
### Shortcodes with Markdown
The `%` character indicates that the shortcode's inner content---called in the [shortcode template][sctemps] with the [`.Inner` variable][scvars]---needs further processing by the page's rendering processor (i.e. markdown via Blackfriday). In the following example, Blackfriday would convert `**World**` to `<strong>World</strong>`:
In Hugo `0.55` we changed how the `%` delimiter works. Shortcodes using the `%` as the outer-most delimiter will now be fully rendered when sent to the content renderer (e.g. Blackfriday for Markdown), meaning they can be part of the generated table of contents, footnotes, etc.
If you want the old behavior, you can put the following line in the start of your shortcode template:
```
{{%/* myshortcode */%}}Hello **World!**{{%/* /myshortcode */%}}
{{ $_hugo_config := `{ "version": 1 }` }}
```
### Shortcodes Without Markdown
The `<` character indicates that the shortcode's inner content does *not* need further rendering. Often shortcodes without markdown include internal HTML: