Componenti

Visualizza come Markdown Modifica su GitHub Documentazione di 7b38e05

Onedocs registra una serie di componenti Fumadocs UI per i vostri file MDX, così potete usarli senza importarli.

Uso dei componenti

Passate mdxComponents ai vostri contenuti MDX:

TSX

import { DocsPage, mdxComponents } from "onedocs";

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

mdxComponents contiene i componenti predefiniti Fumadocs UI (titoli con link di ancoraggio, blocchi di codice, link, immagini, tabelle, Card, Cards e Callout), oltre a Tab, Tabs, Step, Steps, Accordion, Accordions, File, Folder, Files, ImageZoom e TypeTable. Tutti gli esempi seguenti funzionano senza modifiche.

Riquadro informativo

Evidenziate le informazioni importanti. type è uno tra info (predefinito), warn, error, success o 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>

Aggiungete un titolo con title:

Mdx

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

Schede

Organizzate i contenuti in schede. Ogni Tab value corrisponde a una voce in 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>

Card

Collegate altre pagine con griglie di card:

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>

Passaggi

Mostrate i passaggi numerati:

Mdx

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

Accordion

Contenuti comprimibili per FAQ e dettagli facoltativi. È possibile aprire un solo elemento alla volta:

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>

File

Mostrate le strutture ad albero dei file:

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>

Zoom delle immagini

Un'immagine che si apre a grandezza naturale quando viene selezionata. width e height sono obbligatori per le immagini di public/:

Mdx

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

Tabella dei tipi

Documentate le proprietà o le opzioni di un API:

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",
    },
  }}
/>

Altri componenti

InstallBlock e CodeBlock di onedocs non sono in mdxComponents. Per usarli in MDX, aggiungeteli all'oggetto passato:

TSX

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

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

Per qualsiasi altro elemento, importatelo da Fumadocs UI nel vostro file MDX oppure aggiungetelo nello stesso modo:

TypeScript

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

Consultate la documentazione di Fumadocs per l'elenco completo.