Fumadocs

Remark Admonition

在 Fumadocs 中使用 Admonition

在 Docusaurus 中,有一个 Admonition 语法

对于从 Docusaurus 迁移的用户,您可以启用此 remark 插件来支持 Admonition 语法。

使用方法

source.config.ts
import { remarkAdmonition } from 'fumadocs-core/mdx-plugins';
import { defineConfig } from 'fumadocs-mdx/config';

export default defineConfig({
  mdxOptions: {
    remarkPlugins: [remarkAdmonition],
  },
});

输入

:::warning
Hello World
:::

输出

<Callout type='warn'>

Hello World

</Callout>

何时使用

我们强烈推荐使用 MDX 的 JSX 语法代替。 它更灵活,一些编辑器在 MDX 文件中支持 IntelliSense。

<Callout type='warn'>

Hello World

</Callout>

How is this guide?

Last updated on