Remark Admonition
Fumadocs で Admonition を使用する
Docusaurus には Admonition 構文があります。 Docusaurus から移行する場合は、この remark プラグインを有効にすると Admonition 構文を使用できるようになります。
使い方
ディレクティブ構文が必要です。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 構文を使用することを強くおすすめします。 JSX 構文のほうが柔軟性が高く、エディターによっては MDX ファイルで IntelliSense も利用できます。
<Callout type='warn'>
Hello World
</Callout>How is this guide?
最終更新日
General Translation
Ferry Health
assistant-ui
Inkeep