Slideshow Shortcode

The slideshow shortcode allows you to create an interactive image slider with optional captions.
It supports multiple images, custom width, and navigation buttons. Images can come from page resources (i.e. same folder as the markdown file) or the assets folder.


Usage

GO
1
2
3
4
5
6
7
8
{{< slideshow
    slidewidth="90%"
    caption="Journey through the Alps"
    image1="/images/img_mountains.jpg" caption1="Sunrise over the peaks"
    image2="/images/img_forest.jpg" caption2="Morning mist"
    image3="/images/img_lights.jpg" caption3="Reflections on the lake"
    image4="/images/avatar.png" caption4="Avatar"
>}}

Parameters

ParameterRequiredDefaultDescription
slidewidthNo100%Width of the slideshow container (supports %, px, or rem)
captionNo-Optional main caption displayed below the slideshow
image1..image20No-Paths to images to include in the slideshow
caption1..caption20No-Optional captions for each corresponding image
Table: Slideshow Shortcode Parameters

Note: You can include up to 20 images by default. The slideshow automatically skips any empty image parameters.

To increase the number of images that can be included in a slideshow.Go to config/params.toml and edit this:

TOML
1
2
3
    
 [slideshow]
  maxSize=20 


Examples

Basic Slideshow

Slideshow image
Sunrise over the peaks
Slideshow image
Morning mist
Slideshow image
Reflections on the lake
Slideshow image
Avatar

Slideshow With Custom Width and Main Caption

Slideshow image
Sunrise over the peaks
Slideshow image
Morning mist
Slideshow image
Reflections on the lake
Slideshow image
Avatar

Journey through the Alps


Slideshow Without Captions

Slideshow image
Sunrise over the peaks
Slideshow image
Morning mist
Slideshow image
Reflections on the lake
Slideshow image
Avatar