aboutsummaryrefslogtreecommitdiff
path: root/content/blog/hugo/adding-custom-shortcode-age.md
blob: 72fb9bd42872a0d232a51ed76c8ae96a048d63c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
---
title: Custom hugo markdown shortcode
date: 2021-03-22
description: An example of custom hugo shortcode to calculate automatically something
tags:
  - hugo
---

## Introduction

On the [about-me]({{< ref "about-me" >}}) page I had hardcoded my age. I wanted a way to calculate it automatically when building the site, here is how to do this.

## Adding the shortcode

Added a custom markdown shortcode in hugo in as simple as creating a `layouts/shortcodes/` directory. Each html file created inside will define a shortcode from the filename. In my example I want to calculate my age so I named the shortcode `age.html` and added the following simple template code :

{{< highlight html >}}
{{ div (sub now.Unix 493473600 ) 31556926 }}
{{< / highlight >}}

The first number is the timestamp of my birthday, the second represents how many seconds there are in a year.

## Using the shortcode

With this `layouts/shortcodes/age.html` file I can just add the following in a page to add my age :

{{< highlight html >}}
{{< print "{{% age %}}" >}}
{{< / highlight >}}

And if you are wondering how I am able to display a shortcode code inside this page without having it render, it is because I defined another shortcode that does exactly like this :
{{< highlight html >}}
{{< print "{{ index .Params 0 }}" >}}
{{< / highlight >}}

You can find these examples [here](https://git.adyxax.org/adyxax/www/tree/layouts/shortcodes)! Hugo really is a powerful static website generator, it is amazing.

## References

  * https://gohugo.io/content-management/shortcodes/
  * https://github.com/gohugoio/hugo/issues/7561