快轉到主要內容

Media and Content Embeddings

查看原始碼編輯此頁 (外部連結)
首次發表:

Badge 此標題的連結

The badge shortcode renders an inline label. Passing url turns it into a link.

ParameterDescription
textRequired. Label text.
variantOptional. Color, brand, muted, success, warning or danger. Default: brand
appearanceOptional. Style, accent, filled, outlined or filled-outlined. Default: accent
sizeOptional. Size, s, m or l. Default: s
pillOptional. Fully rounded ends. Default: false
urlOptional. Renders the badge as a link. External URLs open in a new tab.
startOptional. Icon name before the label.
endOptional. Icon name after the label.

Example

{{< badge
  text="Success"
  variant="success"
  appearance="filled"
  pill=true
>}}
Success

accent (default)

Info Success Notice Warning Danger

outlined

Info Success Notice Warning Danger

filled

Info Success Notice Warning Danger

filled-outlined

Info Success Notice Warning Danger

Pill, size, and icon

Success Success Success

Email 此標題的連結

The email shortcode obfuscates an email address to reduce exposure to scrapers. The address is base64-encoded at build time and decoded client-side into a mailto link.

ParameterDescription
addressRequired. Email address.

Example

{{< email address="hello@example.com" >}}
Email placeholder

Embed Code 此標題的連結

The embed-code shortcode fetches source code from a remote URL and renders it as a highlighted code block.

ParameterDescription
urlRequired. The absolute URL of the remote source file.
typeOptional. The programming language for syntax highlighting.
linesOptional. Line range in start-end format (e.g. 3-7), or a single line number. Omit to include the entire file.

Example: Fetching specific lines from GitHub

{{< embed-code url="https://raw.githubusercontent.com/githubtraining/hellogitworld/refs/heads/master/src/main/java/com/github/App.java" type="java" lines="3-7" >}}
/**
 * Hello again
 * Hello world!
 * Hello
 */

Embed Markdown 此標題的連結

The embed-md shortcode fetches and renders remote Markdown content. This shortcode must be called with markdown notation ({{/*% %*/}})

ParameterDescription
urlOptional. The absolute URL of the Markdown file.
pageOptional. The logical path of the target internal page.

Example

Include an external page:

{{% embed-md url="https://github.com/ZhenShuo2021/hugo-yore/raw/refs/heads/main/README.md" md=false %}}

Include an internal page:

{{% embed-md page="/docs/shortcodes/40-math/index.md" %}}

Fig 此標題的連結

The fig shortcode renders an image inside a <figure> element with a figcaption that supports footnotes. Use it only when the caption needs a footnote, otherwise use standard Markdown image syntax.

ParameterDescription
srcRequired. Image path.
altOptional. Alt text for the image.
captionOptional. Caption text shown in the figcaption.
attrsOptional. Raw HTML attributes applied to the <figure> element.

Example

{{% fig
  attrs="class='yr-center-cap yr-center-img' style='width:50%'"
  src="/img/04.webp"
  alt=""
  caption="*1234*[^fn_a]"
%}}

[^fn_a]: Footnote text.

12341

This is equivalent to the standard markdown image syntax below, but the syntax does not support footnotes.

![](/img/04.webp "*1234*")
{class="yr-center-cap yr-center-img" style="width:50%"}

Float 此標題的連結

The float shortcode wraps arbitrary content with text flowing around it, floating left or right with configurable width.

ParameterDescription
sideOptional. Float direction, start or end. Default: start
sizeOptional. Float width, s, m, or l. Default: m

Example:

{{% float side="end" %}}

![](/img/04.webp)

{{% /float %}}

Use {{% float-clear %}} to cancel the float effect.

Cols 此標題的連結

cols shortcode allows you to create flexible multi-column layouts with custom widths and optional responsive behaviors. Note that it uses markdown notation ({{% %}}).

ParameterDescription
widthsOptional. Comma-separated list of column widths (e.g., 30%,70%). If not specified, columns are evenly distributed.
rwdOptional. Responsive web design (rwd) controls responsive behavior. When true, columns stack vertically on small screens and display horizontally on larger screens. Default: true
{{% cols widths="70%,30%" rwd=false %}}

![](/img/01.webp)

<!-- cell -->

Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit.

{{% /cols %}}

Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit.

The carousel shortcode displays an image carousel with a main viewport, navigation buttons, and a scrollable thumbnail strip. The inner content uses YAML format to define images.

Images can be specified individually with src, or batch-loaded with match.

ParameterDescription
srcOptional. YAML path to the image configuration file. Takes precedence over the shortcode's inner content.
ratioOptional. Aspect ratio of the slide frame, in x/y format. Default: 4/3
fitOptional. How images fill the frame. contain shows the full image (may letterbox); cover crops to fill. Default: contain
thumbsOptional. Whether to show the thumbnail strip. Default: true
arrowsOptional. Whether to show the previous/next buttons. Default: true
counterOptional. Whether to show the slide counter. Default: true

YAML fields per item:

FieldDescription
srcImage path.
matchGlob pattern to batch-load images. See Match (外部連結) for more details.
captionOptional. Caption text displayed below the main image.
altOptional. Alt text for accessibility. Falls back to caption if omitted.

Example 1: fit="cover" arrows=false

{{< carousel ratio="32/9" fit="cover" arrows=false >}}

- match: /img/*[5-7]* # 05, 06, 07
- src: /img/drop.svg
  caption: carousel caption
  alt: carousel sample image

{{< /carousel >}}

Example 2: thumbs=false counter=false

{{< carousel ratio="32/9" thumbs=false counter=false >}}

- match: /img/*[5-7]* # 05, 06, 07
- src: /img/drop.svg
  caption: carousel caption
  alt: carousel sample image

{{< /carousel >}}

Masonry 此標題的連結

masonry shortcode allows you to create a fluid, masonry-style image wall where items are arranged in columns with varying heights. The inner content uses YAML format to define images.

ParameterDescription
srcOptional. YAML path to the image configuration file. Takes precedence over the shortcode's inner content.
maxColsOptional. The maximum number of columns to display. Default: 3

Images can be specified individually with src, or batch-loaded with match.

YAML fields per item:

FieldDescription
srcImage path.
matchGlob pattern to batch-load images. See Match (外部連結) for more details.
captionOptional. Caption text displayed below the image.
altOptional. Alt text for accessibility. Falls back to caption if omitted.
widthOptional. Image width to prevent layout shift
heightOptional. Image height to prevent layout shift

Example

{{< masonry maxCols="3" >}}

- src: /img/02.webp
  alt: Fly high
  caption: Hello world!
- src: /img/03.webp
  alt: Contrails
- src: /img/04.webp
  alt: Parapet
- src: /img/05.webp
  alt: Wing
- src: /img/06.webp
  alt: Eaves
- src: /img/07.webp
  alt: Biplane sunset
- src: /img/drop.svg
  alt: SVG sample

{{< /masonry >}}

Card 此標題的連結

The card shortcode renders a general-purpose preview card with a title, description, optional image or icon, and metadata.

ParameterDescription
titleOptional. Card heading text, rendered as <h3>. Supports HTML.
urlOptional. Link target for the whole card.
iconOptional. Icon name shown inline before the title.
mediaOptional. Image, video or embed page shown at the top of the card. Accepts a page resource, an assets file, a static path or an external URL. No media is shown when omitted.
mediaTypeOptional. image, video or iframe. Default: resources use their own type, URLs are guessed from the extension (.mp4, .webm, .ogv, .mov mean video, anything else means image). Set it for URLs without extension, e.g. iframe for a YouTube embed.
widthOptional. Media width to prevent layout shift.
heightOptional. Media height to prevent layout shift.
fitOptional. cover or contain. Default: no cropping, full width, height follows the media.
ratioOptional. Display aspect ratio of the media, e.g. 16/9 or 4/2. Implies fit="cover" when fit is not set. iframe defaults to 16/9.
descOptional. Description text shown below the title. Supports HTML.
metaTextOptional. Metadata content shown below the description. Supports HTML.
compactOptional. Set compact mode. Only takes effect within cards shortcode.
attrsOptional. Attributes for card wrapper. Default is data-component=yr-card.
fUrlOptional. Footer action: URL option.
fIdOptional. Footer action: HTML id attribute.
fIconOptional. Footer action: Icon name shown inline before fText.
fTextOptional. Footer action: text content. Supports HTML.
fDownloadOptional. Footer action: Enables the link's download attribute when fUrl is set. A string value specifies the downloaded filename; a non-string truthy value downloads the fUrl.
{{< cards cols=3 align=false >}}
  {{< card
    title="Title Only"
    icon="cube"
  >}}

  {{< card
    title="Title with link"
    icon="cube"
    url="#cards-demo"
  >}}

  {{< card
    desc="Description with link"
    url="#cards-demo"
  >}}
{{< /cards >}}

{{< cards align=true >}}
  {{< card
    title="Example.com"
    url="#cards-demo"
    desc="Sample image"
    media="/img/01.webp"
    icon="steam"
    ratio="16/9"
  >}}

  {{< card
    title="Video Wave"
    url="#cards-demo"
    desc="Video by <a href='https://pixabay.com/users/mario_krimer-34815979/?utm_source=link-attribution&utm_medium=referral&utm_campaign=video&utm_content=353078'>Mario_Krimer</a> from <a href='https://pixabay.com//?utm_source=link-attribution&utm_medium=referral&utm_campaign=video&utm_content=353078'>Pixabay</a>"
    media="https://cdn.zsl0621.cc/2026/docs/wave-rock-splash-sunset-sea-shore-353078.mp4"
    width=16
    height=9
    icon="xbox"
  >}}
{{< /cards >}}

{{< cards >}}
{{< card
  title="With footer button"
  desc="Download <code>01.webp</code> and set a custom downloaded file name"
  fUrl="/img/01.webp"
  fIcon="download"
  fText="Download image"
  fDownload="cocoparisienne-pixabay.webp"
>}}
{{< /cards >}}

Examples

Cards 此標題的連結

The cards shortcode arranges multiple card shortcodes in a responsive grid. Cards inside it always fill the width of their grid cell.

ParameterDescription
colsOptional. Number of columns on large screens. Accepts 1, 2, 3 or 4. Default: 3.
gapOptional. Spacing between cards, s, m, or l. Default: m
alignOptional. Align cells across cards. Works when compact=false in card. Default: true.

Example: align=false

Example: align=true

Example: compact=true

Article Card 此標題的連結

The article shortcode generates a visual preview card for a specified internal page.

ParameterDescription
pathRequired. The logical path of the target internal page.
descOptional. Whether the page description is displayed.
metaOptional. Whether the page metadata is displayed.
langOptional. Get page from another language of your site.

Example

{{< article path="/docs/80-getting-started" desc=true meta=false >}}

Learn how to install the Yore Hugo theme using Git Submodule or Hugo Module, configure it for your site, and launch your first local build in minutes.

GitHub Card 此標題的連結

The github shortcode creates a dynamic preview card for a GitHub repository.

ParameterDescription
repoRequired. Format owner/repo.

Example: Repository preview with thumbnail

{{< github repo="gohugoio/hugo" >}}

The world’s fastest framework for building websites.

Go
90530
8545

Icon 此標題的連結

The icon shortcode renders an inline SVG icon from the theme's icon library.

ParameterDescription
0 / nameRequired. Icon name, with or without the .svg extension. Positional 0 and named name are interchangeable.
labelOptional. Accessible label. When set, the icon is exposed as role="img". Otherwise it is hidden from assistive technology.
classOptional. Extra CSS classes.
rotateOptional. Rotation in degrees, such as 90.
flipOptional. Flip direction: x, y, or both.
animationOptional. Animation: spin, pulse, or bounce.

Example: Positional name

{{< icon "google" >}}
{{< icon name="google" flip="x" >}}
{{< icon name="google" rotate=315 >}}
{{< icon name="google" animation="spin" >}}
{{< icon name="google" animation="pulse" >}}
{{< icon name="google" animation="bounce" class="text-success" >}}

See all available icons in reference page.

Audio 此標題的連結

The audio shortcode embeds a HTML5 audio player.

ParameterDescription
srcRequired. Audio path.
posterOptional. Poster path. If omitted, the shortcode attempts a same-name image in the page bundle.
altOptional. Alt text for the cover image.
captionOptional. Markdown caption shown below the player.
autoplayOptional. Enables autoplay when true. Default: false
loopOptional. Loops when true. Default: false
mutedOptional. Mutes when true. Default: false
controlsOptional. Shows the browser's default playback controls when true. Default: true
preloadOptional. metadata (load info), none (save bandwidth), or auto (preload more). Default: metadata
startOptional. Start time in seconds.
endOptional. End time in seconds.
ratioOptional. Reserved aspect ratio for the cover image, only applied when poster is set. Supports 16/9, 4/3, 1/1, or custom W/H. Default: 1/1
fitOptional. How the cover image fits the ratio: contain (no crop), cover (crop to fill), fill (stretch). Default: contain

Example: Looped muted audio

{{< audio
  src="/audio/beep.mp3"
  caption="*beep*"
  loop=true
>}}
beep

Video 此標題的連結

The video shortcode embeds a HTML5 video player.

ParameterDescription
srcRequired. Video path.
posterOptional. Poster path. If omitted, the shortcode attempts a same-name image in the page bundle.
captionOptional. Markdown caption shown below the video.
autoplayOptional. Enables autoplay when true. Default: false
loopOptional. Loops when true. Default: false
mutedOptional. Mutes when true. Default: false
controlsOptional. Shows the browser's default playback controls when true. Default: true
playsinlineOptional. Inline playback on mobile when true. Default: true
preloadOptional. metadata (load info), none (save bandwidth), or auto (preload more). Default: metadata
startOptional. Start time in seconds.
endOptional. End time in seconds.
ratioOptional. Reserved aspect ratio for the player. Supports 16/9, 4/3, 1/1, or custom W/H. Default: 16/9
fitOptional. How the video fits the ratio: contain (no crop), cover (crop to fill), fill (stretch). Default: contain

Example: Autoplay muted video

{{< video
    src="https://cdn.zsl0621.cc/2026/docs/wave-rock-splash-sunset-sea-shore-353078.mp4"
    caption="Video by <a href='https://pixabay.com/users/mario_krimer-34815979/?utm_source=link-attribution&utm_medium=referral&utm_campaign=video&utm_content=353078'>Mario_Krimer</a> from <a href='https://pixabay.com//?utm_source=link-attribution&utm_medium=referral&utm_campaign=video&utm_content=353078'>Pixabay</a>"
    loop=true
>}}
Video by Mario_Krimer from Pixabay

PDF 此標題的連結

The pdf shortcode embeds a PDF file using an inline iframe viewer.

ParameterDescription
srcRequired. PDF URL or local path. Resolves as page resource first, then global resource, then relative URL.
titleOptional. PDF title for screen readers.
pageOptional. Jumps to a specific page number on load.
heightOptional. Height of the viewer frame. Default: 800px

YouTube 此標題的連結

The youtube shortcode embeds an optimized YouTube video player.

ParameterDescription
idOptional. YouTube video ID.
paramsOptional. URL parameters.

Example: Specific video with start time

{{< youtube id="ldX1Ii0MofQ" params="start=30" >}}

TypeIt 此標題的連結

The typeit shortcode creates dynamic typewriter animations.

ParameterDescription
initialStringOptional. Text shown before animation.
speedOptional. Typing speed in ms. Default: 100
loopOptional. Whether to restart. Default: false
tagOptional. HTML tag for wrapping. Default: div

Example: Looping animation with custom speed

{{< typeit speed="50" loop="true" tag="h2" >}}
Yore - A Simple Yet Powerful Hugo Theme
{{< /typeit >}}


  1. Footnote text. ↩︎

文章關聯

無障礙設定