
# コンポーネント

OnedocsはMDXファイルでインポートなしに使えるよう、FumadocsのUIコンポーネントを登録します。

## コンポーネントの使用

MDXコンテンツに`mdxComponents`を渡します:

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { DocsPage, mdxComponents } from "onedocs";

// In your page component:
<MDX components={mdxComponents} />
```

`mdxComponents`には、FumadocsのUIのデフォルト（アンカーリンク付き見出し、コードブロック、リンク、画像、テーブル、`Card`、`Cards`、`Callout`）に加え、`Tab`、`Tabs`、`Step`、`Steps`、`Accordion`、`Accordions`、`File`、`Folder`、`Files`、`ImageZoom`、`TypeTable`が含まれます。以下の例はすべて、そのまま使用できます。

## コールアウト

重要な情報を強調します。`type`には`info`（デフォルト）、`warn`、`error`、`success`、`idea`のいずれかを指定します:

```mdx
<Callout type="info">
  This is an informational callout.
</Callout>

<Callout type="warn">
  This is a warning callout.
</Callout>

<Callout type="error">
  This is an error callout.
</Callout>
```

`title`で見出しを追加します:

```mdx
<Callout type="warn" title="Breaking change">
  The `docs` option was removed in version 2.
</Callout>
```

## タブ

コンテンツをタブに整理します。各 `Tab` `value` は、`items` のエントリーに対応しています。

```mdx
<Tabs items={["npm", "yarn", "pnpm", "bun"]}>
  <Tab value="npm">npm install onedocs</Tab>
  <Tab value="yarn">yarn add onedocs</Tab>
  <Tab value="pnpm">pnpm add onedocs</Tab>
  <Tab value="bun">bun add onedocs</Tab>
</Tabs>
```

## カード

カードグリッドで他のページへリンクします:

```mdx
<Cards>
  <Card title="Getting Started" href="/docs/getting-started">
    Learn how to set up Onedocs
  </Card>
  <Card title="Configuration" href="/docs/configuration">
    Configure your documentation
  </Card>
</Cards>
```

## 手順

番号付きの手順を表示します:

```mdx
<Steps>
  <Step>Install Onedocs</Step>
  <Step>Create configuration</Step>
  <Step>Write documentation</Step>
</Steps>
```

## アコーディオン

FAQや任意の詳細情報に使える折りたたみコンテンツです。一度に開ける項目は1つだけです:

```mdx
<Accordions>
  <Accordion title="What is Onedocs?">
    Layouts, components and SEO helpers for documentation sites built with Next.js and Fumadocs.
  </Accordion>
  <Accordion title="How do I install it?">
    Follow the install step in Getting Started.
  </Accordion>
</Accordions>
```

## ファイル

ファイルツリーを表示します:

```mdx
<Files>
  <Folder name="content" defaultOpen>
    <Folder name="docs" defaultOpen>
      <File name="index.mdx" />
      <File name="getting-started.mdx" />
    </Folder>
  </Folder>
  <File name="onedocs.config.ts" />
</Files>
```

## 画像の拡大

クリックすると原寸で開く画像です。`public/`の画像では`width`と`height`が必須です:

```mdx
<ImageZoom src="/screenshot.png" alt="Dashboard" width={1200} height={800} />
```

## 型テーブル

APIのpropsやオプションをドキュメント化します:

```mdx
<TypeTable
  type={{
    title: {
      type: "string",
      description: "Site name shown in the navbar.",
    },
    description: {
      type: "string",
      description: "Used for meta tags and the home page.",
      default: "undefined",
    },
  }}
/>
```

## その他のコンポーネント

`onedocs`の`InstallBlock`と`CodeBlock`は`mdxComponents`に含まれていません。MDXで使うには、渡すオブジェクトに追加してください:

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { CodeBlock, DocsPage, InstallBlock, mdxComponents } from "onedocs";

// In your page component:
<MDX components={{ ...mdxComponents, InstallBlock, CodeBlock }} />
```

その他のコンポーネントは、MDXファイルでFumadocsUIからインポートするか、同じ方法で追加してください:

```ts
import { Banner } from "fumadocs-ui/components/banner";
import { InlineTOC } from "fumadocs-ui/components/inline-toc";
```

一覧については[Fumadocsドキュメント](https://fumadocs.dev/docs/ui/components)を参照してください。
