Remark Admonition
在 Fumadocs 中使用 Admonition
Docusaurus 提供了 Admonition 語法。 如果您是從 Docusaurus 遷移過來,可以啟用這個 remark 外掛來支援 Admonition 語法。
使用方式
此功能需要使用 directive 語法。若您使用 unified,請安裝 remark-directive:
npm install remark-directiveSätteri 透過其 directive 功能解析指令,而 Fumadocs MDX 預設即會啟用此功能。
import remarkDirective from 'remark-directive';
import { remarkDirectiveAdmonition } from 'fumadocs-core/mdx-plugins';
import { defineConfig } from 'fumadocs-mdx/config';
export default defineConfig({
mdxOptions: {
remarkPlugins: [remarkDirective, remarkDirectiveAdmonition],
},
});範例
:::tip[This is a `title`]
Hello World
:::
:::warning
Hello World
:::使用時機
我們強烈建議您改用 MDX 的 JSX 語法。 它更有彈性,而且部分編輯器在 MDX 檔案中支援 IntelliSense。
<Callout type='warn'>
Hello World
</Callout>How is this guide?
最後更新於
