Attachments

The Attachments shortcode displays a list of files attached to a page.

Near as I can tell, This shortcode was originally developed by Nelis Oostens¹.

It was subsequently added to the hugo-learn theme², and expanded a bit ³.

Usage #

The shortcurt lists files found in a specific folder. Currently, it support two implementations for pages

1. If your page is a markdown file, attachements must be placed in a folder named like your page and ending with .files.

   • content
     • _index.md
     • page.files
       • attachment.pdf
     • page.md

2. If your page is a folder, attachements must be placed in a nested ‘files’ folder.

   • content
     • _index.md
     • page
       • index.md
       • files
         • attachment.pdf

Be aware that if you use a multilingual website, you will need to have as many folders as languages.

That’s all!

Logs #

Now that hugo has introduced the warnidf⁴ feature I’ve added knobs to disable each of the following log emission methods

• attachments-01 : emits a log message when looking for the attachments directory.
• attachments-02 : emitted when the attachments directory isn’t locatable. likely a legitimate thing to know about
• attachments-03 : emitted when it cannot locate the target icon.

Parameters #

For example:

• To match a file suffix of ‘.jpg’, use .*\.jpg$ (not *.jpg).
• To match file names ending in ‘.jpg’ or ‘.png’, use .*\.(jpg|png)$.

Examples #

List of attachments ending in pdf or mp4 #

{{% attachments title=“Related files” pattern=".*.(pdf|mp4)$" / /%}}

renders as

Colored styled box #

{{% attachments style=“orange” / %}}

renders as

{{% attachments style=“grey” / %}}

renders as

{{% attachments style=“blue” / %}}

renders as

{{% attachments style=“green” / %}}

renders as