コンポーネント

Markdownとして表示 GitHubで編集ドキュメント: 7b38e05

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

コンポーネントの使用

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

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

import { CodeBlock, DocsPage, InstallBlock, mdxComponents } from "onedocs";

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

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

TypeScript

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

一覧についてはFumadocsドキュメントを参照してください。