# Fumadocs (Framework Mode, Next.js): 手動安裝
URL: /zh-TW/docs/next/manual-installation
Source: https://raw.githubusercontent.com/fuma-nama/fumadocs/refs/heads/main/apps/docs/content/docs/(framework)/[framework]/manual-installation.zh-TW.mdx

將 Fumadocs 加入現有的 Next.js 專案。

您也可以使用 [Fumadocs CLI](/docs/cli#init) 自動完成設定：

```npm
npx @fumadocs/cli init
```

## 先決條件 [#prerequisites]

繼續之前，請確認您已設定好：

* Next.js 16。
* Tailwind CSS 4。

本指南使用 [Fumadocs MDX](/docs/mdx) 作為內容來源，請先完成設定：

<div className="fd-steps [&_h3]:fd-step">

### Installation [#installation]

```npm
npm i fumadocs-mdx fumadocs-core @types/mdx
```

Add the plugin to Next.js config:

```js title="next.config.mjs"
import { createMDX } from 'fumadocs-mdx/next';

/** @type {import('next').NextConfig} */
const config = {
  reactStrictMode: true,
};

// [!code ++:4]
const withMDX = createMDX();

// [!code highlight]
export default withMDX(config);
```

<Callout title="ESM Only" type="warn">
Fumadocs MDX is ESM-only, it's recommended to use `next.config.mjs` for accurate ESM resolution.

For TypeScript config file, it requires Native Node.js TypeScript Resolver, you can see [Next.js docs](https://nextjs.org/docs/app/api-reference/config/typescript#using-nodejs-native-typescript-resolver-for-nextconfigts) for details.
</Callout>

### Integrate with Fumadocs [#integrate-with-fumadocs]

Create a `lib/source.ts` file:

```ts title="lib/source.ts"
import { defineDocs } from 'fumadocs-mdx/macro';
import { loader } from 'fumadocs-core/source';

const docs = defineDocs({
  dir: 'content/docs',
});

export const source = loader({
  baseUrl: '/docs',
  source: docs.toFumadocsSource(),
});
```

### Done [#done]

You can now write content in `content/docs` folder.

</div>

<Callout title="小提示">
Fumadocs 也支援其他內容來源，包括 [Content Collections](/docs/headless/content-collections) 與無頭式 CMS。
</Callout>

## 開始使用 [#getting-started]

安裝套件：

```npm
npm i fumadocs-core fumadocs-ui@npm:@fumadocs/base-ui
```

與範本相同，此指令會將 `fumadocs-ui` 安裝為 `@fumadocs/base-ui` 的別名，也就是 Fumadocs UI 的 [Base UI](/docs/ui/component-library) 版本。若要使用 Radix UI 版本，請直接安裝 `fumadocs-ui`，不要使用別名。

### 樣式 [#styles]

請將以下內容加入您的 Tailwind CSS 檔案：

```css
@import 'tailwindcss';
/* [!code ++:2] */
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
```

> Fumadocs UI 沒有預設字型，請從 `next/font` 中選擇一款。

### Root Provider [#root-provider]

請用 [Root Provider](/docs/ui/layouts/root-provider) 包住整個應用程式，並為 `body` 加上必要的樣式。

```tsx title="app/layout.tsx"
import { RootProvider } from 'fumadocs-ui/provider/next';
import type { ReactNode } from 'react';

export default function Layout({ children }: { children: ReactNode }) {
  return (
    <html lang="en" suppressHydrationWarning>
      <body
        // 必要的樣式 [!code ++:2]
        className="flex flex-col min-h-screen"
      >
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}
```

### 路由 [#routes]

請將各版面配置共用的選項放在同一個檔案中：

```tsx title="lib/layout.shared.tsx"
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

export function baseOptions(): BaseLayoutProps {
  return {
    nav: {
      title: 'My App',
    },
  };
}
```

請建立下列檔案：

```tsx tab="components/mdx.tsx"
import defaultMdxComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';

export function getMDXComponents(components?: MDXComponents) {
  return {
    ...defaultMdxComponents,
    ...components,
  } satisfies MDXComponents;
}

export const useMDXComponents = getMDXComponents;

declare global {
  type MDXProvidedComponents = ReturnType<typeof getMDXComponents>;
}
```

```tsx tab="app/docs/layout.tsx"
import { source } from '@/lib/source';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { baseOptions } from '@/lib/layout.shared';

export default function Layout({ children }: LayoutProps<'/docs'>) {
  return (
    <DocsLayout tree={source.getPageTree()} {...baseOptions()}>
      {children}
    </DocsLayout>
  );
}
```

```tsx tab="app/docs/[[...slug]]/page.tsx"
import { source } from '@/lib/source';
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page';
import { notFound } from 'next/navigation';
import { getMDXComponents } from '@/components/mdx';
import type { Metadata } from 'next';
import { createRelativeLink } from 'fumadocs-ui/mdx';

export default async function Page(props: PageProps<'/docs/[[...slug]]'>) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  const MDX = page.data.body;

  return (
    <DocsPage toc={page.data.toc} full={page.data.full}>
      <DocsTitle>{page.data.title}</DocsTitle>
      <DocsDescription>{page.data.description}</DocsDescription>
      <DocsBody>
        <MDX
          components={getMDXComponents({
            // this allows you to link to other pages with relative file paths
            a: createRelativeLink(source, page),
          })}
        />
      </DocsBody>
    </DocsPage>
  );
}

export async function generateStaticParams() {
  return source.generateParams();
}

export async function generateMetadata(props: PageProps<'/docs/[[...slug]]'>): Promise<Metadata> {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  return {
    title: page.data.title,
    description: page.data.description,
  };
}
```

```ts tab="app/api/search/route.ts"
import { source } from '@/lib/source';
import { createFromSource } from 'fumadocs-core/search/server';

export const { GET } = createFromSource(source, {
  // https://docs.orama.com/docs/orama-js/supported-languages
  language: 'english',
});
```

搜尋路由採用 ZBSearch，設定方式請參閱[文件搜尋](/docs/headless/search)。

### 完成 [#finish]

啟動開發伺服器，即可在 `content/docs` 中撰寫您的文件：

```mdx title="content/docs/index.mdx"
---
title: Hello World
---

## Introduction

I love Fumadocs.
```