Markdown Extended Features

Here are some extended Markdown features supported by Retypeset, including syntax examples and their stylistic effects.

Figure Captions

To create automatic figure captions, use the standard Markdown image syntax ![alt](src). To hide the caption, add an underscore _ before the alt text or leave the alt text empty.

Syntax

![Image description](https://image.example.com/image-01.webp)

![_Image description](https://image.example.com/image-01.webp)

Output

Github Repository Cards

To create a Github repository card, use the leaf directive ::github{repo="owner/repo"}. Repository data is fetched in real-time from the GitHub API after the page loads.

Syntax

::github{repo="radishzzz/astro-theme-retypeset"}

Output

Admonition

To create admonition blocks, use the GitHub syntax > [!TYPE] or the container directive :::type. Following types are supported: note, tip, important, warning, and caution.

Syntax

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

:::warning
Urgent info that needs immediate user attention to avoid problems.
:::

:::caution
Advises about risks or negative outcomes of certain actions.
:::

:::note[YOUR CUSTOM TITLE]
This is a note with a custom title.
:::

Output

NOTE

Useful information that users should know, even when skimming content.

TIP

Helpful advice for doing things better or more easily.

IMPORTANT

Key information users need to know to achieve their goal.

WARNING

Urgent info that needs immediate user attention to avoid problems.

CAUTION

Advises about risks or negative outcomes of certain actions.

YOUR CUSTOM TITLE

This is a note with a custom title.

Videos

To embed videos, copy the embed code from YouTube or other video platforms and paste it into your markdown file. You don’t need to keep the width and height parameters.

Syntax

<!-- Youtube -->
<iframe src="https://www.youtube.com/embed/9pP0pIgP2kE?si=Rlk4C4ltaVPHXZ80" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

<!-- Bilibili -->
<iframe src="//player.bilibili.com/player.html?isOutside=true&aid=930327443&bvid=BV1sK4y1Z7KG&cid=329802177&p=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"></iframe>

Output