Hugo Shortcode for Text Highlight #
This shortcode allows you to highlight some text inside a paragraph.
Minimal example #
Highlight absolutely any words you want.
Code:
Highlight {{< highlighter >}}absolutely{{</ highlighter >}} any words you want.
Full example #
Highlight absolutely any words you want.
Code:
Highlight {{< highlighter color="lime" >}}absolutely **any** words {{</ highlighter >}} you want.
Parameters #
Parameter | Default | Description |
---|---|---|
color | yellow | The color to highlight text |
inner text | — | The text (markdown) to highlight |
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.