Formatting |

Embed Media

Tue, 24 Oct 2023 00:00:00 +0000

is designed to give technical content creators a seamless experience. You can focus on the content and the HugoBlox Kit which this template is built upon handles the rest.

Embed videos, podcasts, code, LaTeX math, and even test students!

On this page, you’ll find some examples of the types of technical content that can be rendered with Hugo Blox.

Video

Teach your course by sharing videos with your students. Choose from one of the following approaches:

Youtube:

{{< youtube w7Ft2ymGmfc >}}

Bilibili:

{{< bilibili id="BV1WV4y1r7DF" >}}

Video file

Videos may be added to a page by either placing them in your assets/media/ media library or in your , and then embedding them with the video shortcode:

{{< video src="my_video.mp4" controls="yes" >}}

Podcast

You can add a podcast or music to a page by placing the MP3 file in the page’s folder or the media library folder and then embedding the audio on your page with the audio shortcode:

{{< audio src="ambient-piano.mp3" >}}

Try it out:

Test students

Provide a simple yet fun self-assessment by revealing the solutions to challenges with the spoiler shortcode:

{{< spoiler text="👉 Click to view the solution" >}}
You found me!
{{< /spoiler >}}

renders as

👉 Click to view the solution

You found me 🎉

Math

HugoBlox Kit supports a Markdown extension for $\LaTeX$ math. You can enable this feature by toggling the math option in your config/_default/params.yaml file.

To render inline or block math, wrap your LaTeX math with {{< math >}}$...${{< /math >}} or {{< math >}}$$...$${{< /math >}}, respectively.

Note

We wrap the LaTeX math in the Hugo Blox math shortcode to prevent Hugo rendering our math as Markdown. This callout now uses the standard Markdown alert syntax!

Example math block:

{{< math >}}
$$
\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}
$$
{{< /math >}}

renders as

$$\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}$$

Example inline math {{< math >}}$\nabla F(\mathbf{x}_{n})${{< /math >}} renders as $\nabla F(\mathbf{x}_{n})$ .

Example multi-line math using the math linebreak (\\):

{{< math >}}
$$f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\
1-p_{0}^{*} & \text{if }k=0.\end{cases}$$
{{< /math >}}

renders as

$$ f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\ 1-p_{0}^{*} & \text{if }k=0.\end{cases} $$

Code

HugoBlox Kit utilises Hugo’s Markdown extension for highlighting code syntax. The code theme can be selected in the config/_default/params.yaml file.

```python
import pandas as pd
data = pd.read_csv("data.csv")
data.head()
```

renders as

import pandas as pd
data = pd.read_csv("data.csv")
data.head()

Inline Images

{{< icon name="python" >}} Python

renders as

python Python

Buttons

Mon, 01 Jan 0001 00:00:00 +0000

A modern, customizable button shortcode with gradient styling, icons, and smart link handling.

Basic Usage

Visit External Site

The above buttons are created with:

{{< button url="/contact" >}}Contact Us{{< /button >}}

{{< button url="https://example.com" new_tab="true" style="secondary" >}}Visit External Site{{< /button >}}

Style Variants

Primary (Default)

Primary Button

{{< button url="#" style="primary" >}}Primary Button{{< /button >}}

Secondary

Secondary Button

{{< button url="#" style="secondary" >}}Secondary Button{{< /button >}}

Outline

Outline Button

{{< button url="#" style="outline" >}}Outline Button{{< /button >}}

Ghost

Ghost Button

{{< button url="#" style="ghost" >}}Ghost Button{{< /button >}}

Sizes

Extra Large

{{< button url="#" size="sm" >}}Small Button{{< /button >}}
{{< button url="#" size="md" >}}Medium Button{{< /button >}}
{{< button url="#" size="lg" >}}Large Button{{< /button >}}
{{< button url="#" size="xl" >}}Extra Large{{< /button >}}

Alignment

Left (Default)

Left Aligned

Center

Center Aligned

Right

Right Aligned

{{< button url="#" align="left" >}}Left Aligned{{< /button >}}
{{< button url="#" align="center" >}}Center Aligned{{< /button >}}
{{< button url="#" align="right" >}}Right Aligned{{< /button >}}

With Icons

Icon Before Text

Download

Icon After Text

Continue

{{< button url="#" icon="arrow-down-tray" >}}Download{{< /button >}}
{{< button url="#" icon="arrow-right" icon_position="right" >}}Continue{{< /button >}}

Rounded Corners

Small Radius

Medium Radius (Default)

Medium Radius

Large Radius

Pill Shape

Pill Button

{{< button url="#" rounded="sm" >}}Small Radius{{< /button >}}
{{< button url="#" rounded="md" >}}Medium Radius{{< /button >}}
{{< button url="#" rounded="lg" >}}Large Radius{{< /button >}}
{{< button url="#" rounded="full" >}}Pill Button{{< /button >}}

Advanced Examples

Call-to-Action Button

Get Started Today

{{< button url="/signup" style="primary" size="lg" align="center" icon="rocket-launch" >}}Get Started Today{{< /button >}}

External Link with New Tab

View on GitHub

{{< button url="https://github.com/hugo-blox/kit" new_tab="true" style="outline" icon="arrow-top-right-on-square" icon_position="right" >}}View on GitHub{{< /button >}}

Download Button

Download PDF

{{< button url="/files/document.pdf" style="secondary" icon="document-arrow-down" rounded="full" >}}Download PDF{{< /button >}}

Parameters

Parameter	Type	Default	Description
`url`	string	`#`	Required. Button destination URL (internal or external)
`text`	string	Inner content	Button text (overrides shortcode content)
`new_tab`	boolean	`false`	Whether to open link in new tab
`style`	string	`primary`	Button style: `primary`, `secondary`, `outline`, `ghost`
`size`	string	`md`	Button size: `sm`, `md`, `lg`, `xl`
`align`	string	`left`	Button alignment: `left`, `center`, `right`
`icon`	string	-	Icon name from
`icon_position`	string	`left`	Icon position: `left`, `right`
`rounded`	string	`md`	Border radius: `sm`, `md`, `lg`, `xl`, `full`
`disabled`	boolean	`false`	Whether button should be disabled

Security Features

The button shortcode automatically handles security for external links:

External links get rel="noreferrer" attribute
External links opening in new tab get rel="noopener noreferrer"
Internal links opening in new tab get rel="noopener"

This ensures safe navigation while maintaining functionality.

Accessibility

The button shortcode includes built-in accessibility features:

Proper role="button" attribute
aria-label support
Keyboard focus indicators
High contrast focus rings
Disabled state handling

Callouts

Mon, 01 Jan 0001 00:00:00 +0000

Hugo Blox supports GitHub and Obsidian-style Markdown callouts for maximum compatibility and content portability.

Callouts are a useful feature to draw attention to important or related content such as notes, hints, or warnings in your articles.

Usage

Basic Callout Types

Hugo Blox supports all 15+ callout types from :

Information & Notes:

> [!NOTE]
> This is a note callout with important information that users should know.

Note

This is a note callout with important information that users should know.

> [!INFO]
> Alternative info callout - same styling as NOTE.

Info

Alternative info callout - same styling as NOTE.

> [!ABSTRACT]
> Use for abstracts, summaries, or TL;DR sections.

Abstract

Use for abstracts, summaries, or TL;DR sections.

Actions & Tasks:

> [!TODO]
> This is something that needs to be done.

Todo

This is something that needs to be done.

> [!TIP]
> Here's a helpful tip to make your workflow more efficient!

Tip

Here’s a helpful tip to make your workflow more efficient!

> [!SUCCESS]
> Great job! This operation completed successfully.

Success

Great job! This operation completed successfully.

Questions & Interactive:

> [!QUESTION]
> What do you think about this approach? Let us know!

Question

What do you think about this approach? Let us know!

> [!EXAMPLE]
> Here's a practical example of how to implement this feature.

Example

Here’s a practical example of how to implement this feature.

> [!QUOTE]
> "The best way to predict the future is to invent it." - Alan Kay

Quote

“The best way to predict the future is to invent it.” - Alan Kay

Warnings & Errors:

> [!WARNING]
> Be careful! This action might have unexpected consequences.

Warning

Be careful! This action might have unexpected consequences.

> [!CAUTION]
> Danger! This operation is irreversible and could cause data loss.

Caution

Danger! This operation is irreversible and could cause data loss.

> [!IMPORTANT]
> This is critical information that users must understand to proceed.

Important

This is critical information that users must understand to proceed.

> [!DANGER]
> This is extremely dangerous - proceed with extreme caution!

Danger

This is extremely dangerous - proceed with extreme caution!

> [!FAILURE]
> This operation failed. Check your configuration and try again.

Failure

This operation failed. Check your configuration and try again.

> [!BUG]
> Known issue: This feature doesn't work properly in Safari < 14.

Bug

Known issue: This feature doesn’t work properly in Safari < 14.

Custom Titles

You can customize the title of any callout:

> [!WARNING]+ Custom Warning Title
> This warning has a custom title instead of just "Warning".

Custom Warning Title

This warning has a custom title instead of just “Warning”.

Legacy Syntax (Deprecated)

The old shortcode syntax still works but shows a deprecation warning:

{{< callout note >}}
This still works but is deprecated. Use the Markdown syntax above!
{{< /callout >}}

CSS Customization

Hugo Blox generates callouts with semantic CSS classes and data attributes, making customization easy. Each callout has:

Base class: .callout
Type-specific data attribute: data-callout="note"
Component classes: .callout-icon, .callout-title, .callout-content, .callout-body

Custom CSS Example (add to your assets/css/custom.css):

/* Customize NOTE callouts */
.callout[data-callout="note"] {
 border-left-width: 8px;
 box-shadow: 0 4px 6px -1px rgb(0 0 0 / 0.1);
}

/* Make SUCCESS callouts pulse */
.callout[data-callout="success"] {
 animation: pulse 2s infinite;
}

/* Custom icon styling */
.callout-icon svg {
 transition: transform 0.2s;
}

.callout:hover .callout-icon svg {
 transform: scale(1.1);
}

/* Dark mode overrides */
@media (prefers-color-scheme: dark) {
 .callout[data-callout="warning"] {
 background-color: rgb(92 25 2);
 border-color: rgb(245 158 11);
 }
}

This approach matches , ensuring your styles work across platforms.

Benefits of the New Syntax

Portable: Works with GitHub, Obsidian, and other Markdown editors
Standard: Uses widely-adopted Markdown callout syntax
Clean: No Hugo-specific shortcodes needed
Future-proof: Supported by the latest Hugo versions (0.132.0+)
Customizable: Semantic CSS classes and data attributes for easy styling
Complete: All 15+ Obsidian callout types supported
Multilingual: Callout titles are automatically translated based on your site’s language (and can be customized in the language packs)

Cards

Mon, 01 Jan 0001 00:00:00 +0000

A Hugo extension to create cards. Cards can be shown as links or as plain text.

Usage

Learn Shortcodes A card without an icon or link

is rendered by:

{{< cards >}}
 {{< card url="../callout" title="Callout" icon="academic-cap" >}}
 {{< card url="" title="A card without an icon" >}}
{{< /cards >}}

Options

Parameter	Description
`icon`	Name of the icon. Defaults to
`title`	Title heading for the card.
`subtitle`	Subtitle heading (supports Markdown).
`url`	URL

Spoilers

Mon, 01 Jan 0001 00:00:00 +0000

A Hugo shortcode to toggle collapsible content.

Example

Click to view the spoiler

You found me!

Markdown is supported.

Usage

{{< spoiler text="Click to view the spoiler" >}}

This is the content of the details.

Markdown is **supported**.

{{< /spoiler >}}

Steps

Mon, 01 Jan 0001 00:00:00 +0000

Display a series of steps, such as for a tutorial.

Example

Step 1

The first step here…

Step 2

The second step here…

Step 3

The third step here…

Usage

Use the Markdown level-3 headings to represent step titles within the steps shortcode:

{{% steps %}}

### Step 1

The first step here...

### Step 2

The second step here...

### Step 3

The third step here...

{{% /steps %}}

Formatting |

Embed Media

Video

Podcast

Test students

Math

Code

Inline Images

Did you find this page helpful? Consider sharing it 🙌

Buttons

Basic Usage

Style Variants

Primary (Default)

Secondary

Outline

Ghost

Sizes

Small

Medium (Default)

Large

Extra Large

Alignment

Left (Default)

Center

Right

With Icons

Icon Before Text

Icon After Text

Rounded Corners

Small Radius

Medium Radius (Default)

Large Radius

Pill Shape

Advanced Examples

Call-to-Action Button

External Link with New Tab

Download Button

Parameters

Security Features

Accessibility

Callouts

Usage

Basic Callout Types

Custom Titles

Legacy Syntax (Deprecated)

CSS Customization

Benefits of the New Syntax

Cards

Usage

Options

Spoilers

Example

Usage

Steps

Example

Step 1

Step 2

Step 3

Usage