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 . To hide the caption, add an underscore _ before the alt text or leave the alt text empty.
Syntax
Output
Admonition Blocks
To create admonition blocks, use the GitHub syntax > [!TYPE] or the container directive :::type. The 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
NOTEUseful information that users should know, even when skimming content.
TIPHelpful advice for doing things better or more easily.
IMPORTANTKey information users need to know to achieve their goal.
WARNINGUrgent info that needs immediate user attention to avoid problems.
CAUTIONAdvises about risks or negative outcomes of certain actions.
YOUR CUSTOM TITLEThis is a note with a custom title.
Collapsible Sections
To create collapsible sections, use the container directive syntax :::fold[title]. Click the title to expand or collapse.
Syntax
:::fold[Usage Tips]
Content that may not interest all readers can be placed in a collapsible section.
:::Output
Usage Tips
Content that may not interest all readers can be placed in a collapsible section.
Galleries
To create image galleries, use the container directive :::gallery. Scroll horizontally to view more images.
Syntax
:::gallery
:::Output
GitHub Repositories
To create GitHub repository cards, 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
Loading repository data...
Videos
To embed videos, use the leaf directive ::youtube{id="videoId"}.
Syntax
::youtube{id="9pP0pIgP2kE"}
::bilibili{id="BV1sK4y1Z7KG"}Output
Tweets
To embed tweet cards, use the leaf directive ::tweet{url="tweetUrl"}.
Syntax
::tweet{url="https://x.com/hachi_08/status/1906456524337123549"}