Componentes

Ver como Markdown Editar no GitHub Documentação em 7b38e05

Onedocs registra um conjunto de componentes Fumadocs UI para seus arquivos MDX, para que você possa usá-los sem importá-los.

Usar componentes

Passe mdxComponents ao conteúdo MDX:

TSX

import { DocsPage, mdxComponents } from "onedocs";

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

mdxComponents contém os padrões Fumadocs UI (títulos com links de âncora, blocos de código, links, imagens, tabelas, Card, Cards e Callout), além de Tab, Tabs, Step, Steps, Accordion, Accordions, File, Folder, Files, ImageZoom e TypeTable. Todos os exemplos abaixo funcionam sem alterações com ele.

Destaque

Destaque informações importantes. type pode ser um de info (o padrão), warn, error, success ou 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>

Adicione um título com title:

Mdx

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

Abas

Organize o conteúdo em abas. Cada Tab value corresponde a uma entrada em 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>

Cartões

Crie links para outras páginas usando grades de cartões:

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>

Etapas

Mostre etapas numeradas:

Mdx

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

Acordeão

Conteúdo recolhível para perguntas frequentes e detalhes opcionais. Apenas um item fica aberto por vez:

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>

Arquivos

Mostre árvores de arquivos:

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 de imagem

Uma imagem que abre em tamanho real ao ser clicada. width e height são obrigatórios para imagens de public/:

Mdx

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

Tabela de tipos

Documente as propriedades ou opções de um 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",
    },
  }}
/>

Mais componentes

InstallBlock e CodeBlock de onedocs não fazem parte de mdxComponents. Para usá-los em MDX, adicione-os ao objeto que você passa:

TSX

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

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

Para qualquer outra coisa, importe-a de Fumadocs UI no seu arquivo MDX ou adicione-a da mesma forma:

TypeScript

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

Consulte a documentação de Fumadocs para ver a lista completa.