Markdown Extended Features

Nov 29, 2024 · 5min

GitHub Repository Cards

You can add dynamic cards that link to GitHub repositories, on page load, the repository information is pulled from the GitHub API.

::github{repo="matsuzaka-yuki/Mizuki"}

Create a GitHub repository card with the code ::github{repo="matsuzaka-yuki/Mizuki"}.

::github{repo="matsuzaka-yuki/Mizuki"}

Admonitions

Following types of admonitions are supported: note tip important warning caution

:::note Highlights information that users should take into account, even when skimming. :::

TIP

Optional information to help a user be more successful.

:::important Crucial information necessary for users to succeed. :::

WARNING

Critical content demanding immediate user attention due to potential risks.

:::caution Negative potential consequences of an action. :::

Basic Syntax

:::note
Highlights information that users should take into account, even when skimming.
:::

:::tip
Optional information to help a user be more successful.
:::

Custom Titles

The title of the admonition can be customized.

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

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

GitHub Syntax

Tip

The GitHub syntax is also supported.

> [!NOTE]
> The GitHub syntax is also supported.

> [!TIP]
> The GitHub syntax is also supported.

Spoiler

You can add spoilers to your text. The text also supports Markdown syntax.

The content :spoiler[is hidden ayyy]!

The content :spoiler[is hidden **ayyy**]!
CC BY-NC-SA 4.0 2025-PRESENT © 「钟神秀」@ZSX