Hugo Shortcode for Download File Link #

Sometimes browsers are too smart and they open files instead of downloading them. If you want to allow your readers to download a file in one click, this shortcode will help you.

Minimal example #

For minimum usage you have to specify URL of file: ./file.txt

Code:

{{< download url="./file.txt" />}}

Full example #

Download this “Test File.txt”

Parameters #

Parameter	Default	Description
`url`	—	The URL to download file
`filename`	original filename	The name to save the file. Useful if your file has some weird URL but you want to provide a readable name for users.
inner text	`url` param value	The text to show

Installation #

Don’t forget to install shortcode before usage.

Install all shortcodes at once

If you need dozens of them, it’s better to attach this repository as a theme to your website.

First, add the theme as a git submodule:

git submodule add -b theme https://github.com/isqua/hugo-shortcodes.git themes/hugo-shortcodes

Then add the theme to your config.toml. Most likely you have the following line in your config:

theme = 'ananke'

There may be another theme in place of “ananke”.

Then surround the theme with square brackets, and appends 'hugo-shortcodes' with a comma at the end:

theme = [ 'ananke', 'hugo-shortcodes' ]

That’s it! If your hugo server is running, it is better to restart it to avoid unexpected behavior.

Now you can use all the shortcodes on any content page of your site.

Install only current shortcode

If you need only one shortcode or installing a theme is too complicated, you may get it easier.

First, download shortcode file.
Put the file into your layouts/shortcodes folder.

That’s it! If your hugo server is running, it is better to restart it to avoid unexpected behavior.

Now you can use the shortcode on any content page of your site.