Markdown Extended Features

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=“LyraVoid/Mizuki”}

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

1::github{repo="LyraVoid/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

1:::note
2Highlights information that users should take into account, even when skimming.
3:::
4
5:::tip
6Optional information to help a user be more successful.
7:::

Custom Titles

The title of the admonition can be customized.

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

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

GitHub Syntax

[!TIP] The GitHub syntax is also supported.

1> [!NOTE]
2> The GitHub syntax is also supported.
3
4> [!TIP]
5> 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]!

1The content :spoiler[is hidden **ayyy**]!