Markdown source block with Hugo shortcodes

tags: src-block shortcode

Description/Summary

Content

Shortcodes escaped #

The figure shortcodes in the two Markdown source code blocks below should not be expanded.. they should be visible verbatim.

• {{< .. >}} — Shortcodes without Markdown
• {{% .. %}} — Shortcodes with Markdown

Code block using code fences #

{{< figure src="https://ox-hugo.scripter.co/test/images/org-mode-unicorn-logo.png" >}}
{{% figure src="https://ox-hugo.scripter.co/test/images/org-mode-unicorn-logo.png" %}}

Code block using code fences with line numbering enabled #

Here, the -n switch is added to the Org source block to enable line numbering.

1
2

{{< figure src="https://ox-hugo.scripter.co/test/images/org-mode-unicorn-logo.png" >}}
{{% figure src="https://ox-hugo.scripter.co/test/images/org-mode-unicorn-logo.png" %}}

Shortcode escaped in Org source blocks #

#+macro: relref @@hugo:[@@ $1 @@hugo:]({{< relref "$2" >}})@@

Shortcode escaped in Emacs-Lisp source blocks #

ox-hugo Issue #680

;; Follow Hugo links
(defun org-hugo-follow (link)
  "Follow Hugo link shortcodes"
  (org-link-open-as-file
   (string-trim "{{% ref test.org %}}" "{{% ref " "%}}")))

;; New link type for Org-Hugo internal links
(org-link-set-parameters
 "hugo"
 :complete (lambda ()
             (concat "{{% ref */"
                     (file-name-nondirectory
                      (read-file-name "File: "))
                     " %}}"))
 :follow #'org-hugo-follow)

Shortcodes not escaped #

The figure shortcode in the below example block should be expanded.. you should be seeing a little unicorn below.

Above a #+begin_example .. #+end_example block is chosen arbitrarily. The Hugo shortcodes will remain unescaped in any source/example block except for Markdown source blocks (annotated with md language).

Below, the same figure shortcode is called with the % syntax.

Note

If you are using Hugo 0.55.0 or newer, you will just see the raw HTML from this shortcode (unrendered HTML) because the behavior of {{% .. %}} shortcodes changed in Hugo v0.55.0.

<figure><img src="https://ox-hugo.scripter.co/test/images/org-mode-unicorn-logo.png"/>
</figure>

It is necessary to set the Hugo site config variable markup.highlight.codeFences to true (default) for syntax highlighting to work for fenced code blocks.

Page (Debug)

Page Params (Debug)

File Object (Debug)