Reworked some docs _index and added an article on hugo shortcodes

This commit is contained in:
Julien Dessaux 2021-03-22 22:58:22 +01:00
parent e960153727
commit e0fd5578d2
7 changed files with 47 additions and 8 deletions

View file

@ -0,0 +1,36 @@
---
title: "Adding a custom hugo markdown shortcode to calculate an age"
date: 2021-03-22
description: An example of custom hugo shortcode
tags:
- hugo
---
## Introduction
On the [about-me]({{< relref "/docs/about-me/_index.md" >}}) 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 that [here](https://git.adyxax.org/adyxax/www/src/branch/master/layouts/shortcodes/print.html)! 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

View file

@ -8,7 +8,7 @@ tags:
## Introduction
I felt a need for minimalism. I felt uneasy at the thought of 11 requests totalling about 750KB of minified files just to display a home page without any images, all that because of the docsy theme I went with when I [switched to hugo]({{< relref "/blog/miscellaneous/switching-to-hugo" >}}) two years ago.
I felt a need for minimalism. I felt uneasy at the thought of 11 requests totalling about 750KB of minified files just to display a home page without any images, all that because of the docsy theme I went with when I [switched to hugo]({{< relref "/blog/hugo/switching-to-hugo" >}}) two years ago.
I am not complaining about the theme which served me well when I needed to switch and was so focused on manually importing 10 years worth of wiki articles, but this uneasiness prevented me from updating this blog as often as I wanted. I was a bit ashamed about how heavy it was, and in some way prevented me from adding content to this website.