告示
除了支持 Markdown 的基本语法外,我们还使用 remark-admonitions和 MDX 来支持告示 (Admonition)功能。 告示由 3 个冒号开头。
示例:
:::note
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::tip
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::info
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::caution
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::danger
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
note
Some content with markdown syntax
. Check this api
.
tip
Some content with markdown syntax
. Check this api
.
info
Some content with markdown syntax
. Check this api
.
caution
Some content with markdown syntax
. Check this api
.
danger
Some content with markdown syntax
. Check this api
.
#
指定标题您也可以指定可选标题
:::note Your Title
Some **content** with _markdown_ `syntax`.
:::
您的标题
Some content with markdown syntax
.
#
Admonitions with MDXYou can use MDX inside admonitions too!
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::tip Use tabs in admonitions
<Tabs defaultValue="apple" values={[ {label: 'Apple', value: 'apple'}, {label: 'Orange', value: 'orange'}, {label: 'Banana', value: 'banana'}, ]}> <TabItem value="apple">This is an apple 🍎</TabItem> <TabItem value="orange">This is an orange 🍊</TabItem> <TabItem value="banana">This is a banana 🍌</TabItem></Tabs>
:::
Use tabs in admonitions
- Apple
- Orange
- Banana
This is an apple 🍎
This is an orange 🍊
This is a banana 🍌