# Primeiros passos

Este guia configura um site de documentação com Onedocs a partir de uma pasta vazia. Se você já tem um projeto Next.js, ignore os arquivos que já possui e compare o restante.

## Pré-requisitos

- Node.js 20.9 ou posterior (exigido por Next.js 16)
- Next.js 16 com o App Router, React 19.2 ou posterior
- Tailwind CSS v4 (a predefinição Onedocs CSS importa `tailwindcss`)

A predefinição Fumadocs UI 16 só oferece suporte a Next.js 16 e React 19.2. Por isso, versões anteriores de Next.js ou React não funcionam, embora os metadados do pacote `onedocs` ainda as listem ([#5](https://github.com/inline0/onedocs/issues/5)).

## Instalação

Onedocs não inclui Next.js nem Fumadocs. Eles são dependências de pares, então instale-os ao lado dele:

```bash
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
npm install -D tailwindcss @tailwindcss/postcss typescript @types/react @types/react-dom @types/node
```

Mantenha a fixação de versão `lucide-react@0.562`. `onedocs` 0.1.27 declara `lucide-react` `^0.562.0` como dependência de par; sem essa fixação, npm instala lucide-react 1.x e termina com um erro de `ERESOLVE` ([#1](https://github.com/inline0/onedocs/issues/1)).

Os mesmos pacotes funcionam com pnpm, yarn ou bun.

Adicione os scripts de Next.js a `package.json`:

```json title="package.json"
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  }
}
```

## Estrutura do projeto

Veja o que você terá ao final:

```
your-project/
├── content/
│   └── docs/
│       ├── index.mdx
│       └── meta.json
├── public/
│   └── fonts/
│       └── InterVariable.woff2
├── src/
│   ├── app/
│   │   ├── layout.tsx
│   │   ├── page.tsx
│   │   ├── globals.css
│   │   └── docs/
│   │       ├── layout.tsx
│   │       └── [[...slug]]/
│   │           └── page.tsx
│   └── lib/
│       └── source.ts
├── onedocs.config.ts
├── source.config.ts
├── next.config.mjs
├── postcss.config.mjs
├── tsconfig.json
└── package.json
```

Vamos criar cada arquivo.

## Arquivos de configuração

### onedocs.config.ts

Seu principal arquivo de configuração. Apenas `title` é obrigatório; consulte [Configuração](https://onedocs.inline0.dev/pt/docs/configuration) para ver o restante.

```ts title="onedocs.config.ts"
import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Docs",
  description: "Documentation for my project",
  nav: {
    github: "username/repo",
  },
});
```

### source.config.ts

Informa a Fumadocs MDX onde está o conteúdo. Este é o único lugar em que a pasta de conteúdo é definida:

```ts title="source.config.ts"
import { defineDocs } from "fumadocs-mdx/config";

export const docs = defineDocs({
  dir: "content/docs",
});
```

### next.config.mjs

Habilita o processamento de MDX:

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

const withMDX = createMDX();

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

export default withMDX(config);
```

Fumadocs MDX gera uma pasta `.source/` a partir de `source.config.ts` quando Next.js é iniciado. Adicione `.source` a `.gitignore`.

### postcss.config.mjs

Executa Tailwind CSS v4, sobre o qual a predefinição Onedocs CSS é construída:

```js title="postcss.config.mjs"
export default {
  plugins: {
    "@tailwindcss/postcss": {},
  },
};
```

### tsconfig.json

Os exemplos abaixo importam de `@/`, então mapeie-o para `src/`:

```json title="tsconfig.json"
{
  "compilerOptions": {
    "paths": {
      "@/*": ["./src/*"]
    }
  }
}
```

Next.js adiciona a este arquivo as opções restantes do compilador necessárias na primeira vez que você executa `next dev` ou `next build`.

## Configuração da fonte

### src/lib/source.ts

Carrega o conteúdo da documentação:

```ts title="src/lib/source.ts"
import { loader } from "fumadocs-core/source";
import { docs } from "../../.source/server";

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

## Arquivos do app

### src/app/layout.tsx

Seu layout raiz:

```tsx title="src/app/layout.tsx"
import type { Metadata } from "next";
import { RootProvider } from "fumadocs-ui/provider/next";
import { FontHead } from "onedocs";
import "./globals.css";

export const metadata: Metadata = {
  title: "My Docs",
  description: "Documentation for my project",
};

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <FontHead />
      </head>
      <body className="antialiased">
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}
```

`RootProvider` de Fumadocs UI fornece a janela de pesquisa e o tema claro e escuro. `FontHead` pré-carrega a fonte Inter Variable de `/fonts/InterVariable.woff2` e a define como fonte da página. Onedocs não inclui o arquivo da fonte: baixe `InterVariable.woff2` de [lançamentos do Inter](https://github.com/rsms/inter/releases) e coloque-o em `public/fonts/`. Sem ela, o texto usa a fonte sem serifa do sistema como alternativa.

Para gerar esses metadados a partir da sua configuração, consulte `createMetadata` em [API Referência](https://onedocs.inline0.dev/pt/docs/api-reference#createmetadata).

### src/app/globals.css

Importe a predefinição CSS:

```css title="src/app/globals.css"
@import "onedocs/css/preset.css";

@source "./**/*.tsx";
@source "../../content/**/*.mdx";
```

A predefinição carrega Tailwind CSS, os estilos Fumadocs UI e os estilos do layout Onedocs. Os caminhos de `@source` são relativos a `globals.css`, portanto estas duas linhas apontam para `src/app/` e para a pasta `content/` na raiz do projeto.

### src/app/page.tsx

A página inicial. `HomePage` renderiza o destaque, os recursos e o rodapé da sua configuração:

```tsx title="src/app/page.tsx"
import { HomePage } from "onedocs";
import config from "../../onedocs.config";

export default function Home() {
  return <HomePage config={config} packageName="my-package" />;
}
```

`packageName` adiciona comandos de instalação para npm, yarn, pnpm e bun ao destaque. Remova-o se o seu projeto não for um pacote.

### src/app/docs/layout.tsx

Layout da documentação com barra lateral:

```tsx title="src/app/docs/layout.tsx"
import { DocsLayout } from "onedocs";
import type { ReactNode } from "react";
import { source } from "@/lib/source";
import config from "../../../onedocs.config";

export default function Layout({ children }: { children: ReactNode }) {
  return (
    <DocsLayout config={config} pageTree={source.pageTree}>
      {children}
    </DocsLayout>
  );
}
```

### src/app/docs/[[...slug]]/page.tsx

Páginas individuais da documentação:

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { source } from "@/lib/source";
import { DocsPage, mdxComponents } from "onedocs";
import { notFound } from "next/navigation";

export default async function Page(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  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}>
      <MDX components={mdxComponents} />
    </DocsPage>
  );
}

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

export async function generateMetadata(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

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

## Conteúdo

### content/docs/index.mdx

Cada página precisa de um `title` nos metadados iniciais. O `description` é opcional:

```mdx title="content/docs/index.mdx"
---
title: Introduction
description: What this project does.
---

Welcome to the docs. Components such as `<Callout>` work without imports; see [Components](/docs/components).
```

### content/docs/meta.json

Define a ordem da barra lateral:

```json title="content/docs/meta.json"
{
  "pages": ["index"]
}
```

Adicione uma página criando outro arquivo `.mdx` e listando o nome dela em `pages`.

## Executar

Inicie o servidor de desenvolvimento:

```bash
npm run dev
```

A página inicial fica em `http://localhost:3000` e a documentação em `http://localhost:3000/docs`.

Compile para produção:

```bash
npm run build
```

Em seguida, adicione pesquisa, um mapa do site e llms.txt em [SEO & Pesquisa](https://onedocs.inline0.dev/pt/docs/seo-search).