Markdown Extended Features

Admonitions#

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

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
2
Highlights information that users should take into account, even when skimming.
3
:::
4

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

Custom Titles#

The title of the admonition can be customized.

MY CUSTOM TITLE

This is a note with a custom title.

1
:::note[MY CUSTOM TITLE]
2
This 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 is hidden ayyy!

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

Stellar Tag Plugins (Migration Test)#

Box Example

A box container with markdown content.

Click to expand

Hidden content with bold text.

Note

A styled note with green accent.

Click Me

静夜思

李白盛唐

床前明月光，疑是地上霜。举头望明月，低头思故乡。

兰亭集序

永和九年，岁在癸丑，暮春之初，会于会稽山阴之兰亭，修禊事也。

群贤毕至，少长咸集。此地有崇山峻岭，茂林修竹；又有清流激湍，映带左右，引以为流觞曲水，列坐其次。

感怀

夫人之相与，俯仰一世。或取诸怀抱，悟言一室之内；或因寄所托，放浪形骸之外。

兴叹

每览昔人兴感之由，若合一契，未尝不临文嗟悼，不能喻之于怀。

后之视今，亦犹今之视昔。

固知一死生为虚诞，齐彭殇为妄作。

Admonitions#

Basic Syntax#

Custom Titles#

GitHub Syntax#

Spoiler#

Stellar Tag Plugins (Migration Test)#

评论