search

akuznecov / hugo-shortcode-spoiler

Spoiler shortcode for Hugo https://gohugo.io/
4 stars 0 forks source link

readme

Description

Spoiler shortcodes (also known as "cut tags") allow you to write text that some users may not want to see and hide until the reader chooses to see it.

Demo

Demo post

Setup

  1. Download repository content and put into your Hugo site structure (into root or inside of theme)
  2. Include spoiler.css and spoiler.js on your site via modification of <head> tag or with your theme properties.
  3. Include JQuery on your site via modification of <head> tag. For example, <script src="https://github.com/akuznecov/hugo-shortcode-spoiler/raw/master//cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js"></script>

Usage

Syntax is quite basic

Spoiler shortode without Markdown

https://gohugo.io/content-management/shortcodes/#shortcodes-without-markdown

{{< spoiler >}}
Hidden content!
{{< /spoiler >}}
Spoiler shortcode with Markdown

https://gohugo.io/content-management/shortcodes/#shortcodes-with-markdown

{{% spoiler %}}
- Hidden
- **content**
{{% /spoiler %}}
Nested spoiler
{{< spoiler >}}
Foo
{{% spoiler %}}
Bar
{{% /spoiler %}}
{{< /spoiler >}}
Spoiler with text in header
{{% spoiler text="Foo" %}}
`bar`
{{% /spoiler %}}

Known issues