A shortcode collection for Hugo

Icon Shortcode

Usage

As a shortcode:

{{< ico moon >}}
{{< ico moon solid >}}

With named parameters:

{{< ico icon="moon" >}}
{{< ico icon="moon" theme="solid" >}}

As a partial:

{{ partial "ico" "moon" }}

Embed audio file

Mission: easily embed players from local and remote audio files

Usage:

{{< audio "https://archive.org/download/test/aufiofile.mp3" >}}

Screenshot:

Options are available. Here we define a caption

{{< audio "/audiofilename.mp3" "A custom comment" >}}

Named parameters can be used too:

{{< audio src="/audiofilename.mp3" caption="A custom comment" class="foo" preload="none" >}}

This shortcode is based on Plyr.io, see the documentation to learn about the installation and features

Embed multiple audio files from Archive.org

Usage:

{{< archive-audio "https://archive.org/details/heyamoli" >}}

Demo: See https://phoni.es/dev/v4/

Embed video file

Mission: easily embed players from local and remote video files

Usage:

{{< video "https://archive.org/download/tesfile.mp4" >}}

Options are available. Here we define a caption:

{{< video "/testfile.mp4" "A custom caption" >}}

Named parameters can be used too:

{{< video src="/test-file.mp4" caption="A custom comment"  poster="preview-image.jpg" class="foo" preload="none" >}}

Customized text blocks

Usage:

{{< box info >}}
  Incididunt labore eiusmod culpa eu nostrud tempor laborum consequat eiusmod excepteur.
{{< /box >}}

Screenshot:

See the demo and documentation for details.

List Github stars

Mission: Display a list of the last starred repositories on Github on your website. This list is automatically updated every time the website is rebuilt.

Screenshot:

See the demo for live examples and the documentation for guidance.

Installation

Install the collection as a Git submodule:

git submodule add https://gitlab.com/Roneo/hugo-shortcode-roneo-collection.git themes/hugo-shortcode-roneo-collection

Then edit your configuration file this way:

theme = ["hugo-shortcode-roneo-collection", "YourCurrentTheme"]

enableInlineShortcodes = true

Found a problem?

Please open an issue on Github / Gitlab or drop me an email.

Contribute

Code contributions are welcome, and the main place for development is this Gitlab repo. You can use this Github repo too.

Please star this repo on Github or Gitlab, to help this project gain some visibility and reach new contributors.

References

• Hugo documentation about Theme Components
• Hugo documentation about Shortcodes