包安装

已弃用

对于 Fumadocs MDX，现在默认启用。

您可以使用来自 fumadocs-core/mdx-plugins 的 remarkNpm 插件替代。

用法

npm install fumadocs-docgen

添加 remark 插件。

source.config.ts

import { remarkInstall } from 'fumadocs-docgen';
import { defineConfig } from 'fumadocs-mdx/config';

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

定义所需的组件。

mdx-components.tsx (Fumadocs UI)

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
import defaultComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';

export function getMDXComponents(components?: MDXComponents): MDXComponents {
  return {
    ...defaultComponents,
    Tab,
    Tabs,
    ...components,
  };
}

Component
Tabs	接受项目数组 (`items`)
Tab	接受项目名称 (`value`)

使用 package-install 作为语言创建代码块。

```package-install
my-package
```

```package-install
npm i my-package -D
```

输出

插件应该生成以下结构。

<Tabs items={['npm', 'pnpm', 'yarn', 'bun']}>
  <Tab value="npm">...</Tab>
  <Tab value="pnpm">...</Tab>
  <Tab value="yarn">...</Tab>
  <Tab value="bun">...</Tab>
</Tabs>

npm install my-package

选项

持久化

在使用 Fumadocs UI 时，您可以使用 persist 选项启用持久化。

source.config.ts

import { remarkInstall } from 'fumadocs-docgen';
import { defineConfig } from 'fumadocs-mdx/config';

const remarkInstallOptions = {
  persist: {
    id: 'some-id',
  },
};

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

这将生成：

<Tabs groupId="some-id" persist items={[...]}>
  ...
</Tabs>

用法

输出

选项

持久化

On this page