Attachments

The attachments shortcode displays a list of files attached to a page with adjustable color, title and icon.

Attachments

Usage

The shortcurt lists files found in a specific folder.

{{% attachments /%}}

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.

Parameter

Name Optional Default Notes
style yes transparent The color scheme used to highlight the box content.

- by severity: info, note, tip, warning
- by brand color: primary, secondary
- by color: blue, green, grey, orange, red
- by special color: default, transparent
title yes see notes Arbitray text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other colors: Attachments

If you want no title, you have to set this parameter to " " (a non empty string filled with spaces)
icon yes see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.

- for severity styles: a nice matching icon for the severity
- for all other colors: paperclip

If you want no icon, you have to set this parameter to " " (a non empty string filled with spaces)
sort yes asc Sorting the output in ascending or descending order.
pattern yes .* A regular expressions, used to filter the attachments by file name. 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

Custom title, list of attachments ending in pdf or mp4

Related files
Show markup

Info styled box, descending sort order

Info
Show markup

Style and icons

For further examples for style, title and icon, see the notice shortcode documentation. The parameter are working the same way for both shortcodes, besides having different defaults.