# Introdução

Onedocs é um conjunto de layouts, componentes e auxiliares para sites de documentação criados com Next.js e Fumadocs. Você escreve Markdown, descreve seu site em um único arquivo de configuração, e Onedocs fornece a estrutura da documentação, uma página inicial e as rotas SEO.

Ele foi criado para sites de documentação independentes, não para adicionar documentação a um aplicativo existente.

## O que Onedocs oferece

Além de Fumadocs, o pacote `onedocs` oferece:

- **Layouts** - `DocsLayout` e `DocsPage` envolvem o layout de documentação Fumadocs UI, com barra lateral, pesquisa, alternância de tema e sumário. `HomePage` renderiza uma página inicial com destaque, comandos de instalação, recursos e rodapé.
- **Um arquivo de configuração** - `onedocs.config.ts` contém o título, a descrição, o logotipo, o favicon, os links de navegação, o rodapé e o conteúdo da página inicial.
- **Componentes MDX** - `mdxComponents` registra caixas de destaque, abas, cartões, etapas, acordeões, árvores de arquivos, ampliação de imagens e tabelas de tipos, para que as páginas usem esses elementos sem importações.
- **Predefinição CSS** - uma importação carrega Tailwind CSS v4, o tema Fumadocs UI e os estilos do layout Onedocs.
- **Auxiliares SEO** - funções para `sitemap.xml`, `robots.txt`, `llms.txt`, `llms-full.txt`, metadados de página e imagens Open Graph.

## O que você configura por conta própria

Onedocs não inclui Next.js nem Fumadocs. Eles são dependências de pares que você instala ao lado dele:

```bash
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
```

Você também precisa de Tailwind CSS v4, Node.js 20.9 ou posterior, e cerca de dez arquivos pequenos: as configurações de Next.js e Fumadocs MDX, uma fonte de conteúdo, o layout raiz, o layout da documentação e a rota da página de documentação. [Primeiros passos](https://onedocs.inline0.dev/pt/docs/getting-started) mostra cada um deles.

## Onde cada item é configurado

| O quê | Onde |
|------|-------|
| Título do site, logotipo, navegação, rodapé | `onedocs.config.ts`, consulte [Configuração](https://onedocs.inline0.dev/pt/docs/configuration) |
| Destaque e recursos da página inicial | `homepage` em `onedocs.config.ts`, renderizado por `HomePage` em `src/app/page.tsx` |
| Layout e páginas da documentação | `src/app/docs/layout.tsx` e `src/app/docs/[[...slug]]/page.tsx`, consulte [Primeiros passos](https://onedocs.inline0.dev/pt/docs/getting-started) |
| Pasta de conteúdo e ordem da barra lateral | `source.config.ts` e `content/docs/meta.json` |
| Componentes MDX | `mdxComponents`, consulte [Componentes](https://onedocs.inline0.dev/pt/docs/components) |
| Pesquisa, mapa do site, robots.txt, llms.txt | Arquivos de rota em `src/app/`, consulte [SEO & Pesquisa](https://onedocs.inline0.dev/pt/docs/seo-search) |
| Metadados e imagens Open Graph | `onedocs/metadata` e `onedocs/og`, consulte [API Referência](https://onedocs.inline0.dev/pt/docs/api-reference) |

## Filosofia

- **Markdown em primeiro lugar** - Escreva `.md` ou `.mdx` e obtenha a documentação
- **Um arquivo de configuração** - As configurações do site ficam em `onedocs.config.ts`
- **Mais controle** - Precisa de mais controle? Use Fumadocs diretamente

## Comece aqui

- [Primeiros passos](https://onedocs.inline0.dev/pt/docs/getting-started)
- [Componentes](https://onedocs.inline0.dev/pt/docs/components)
- [SEO & Pesquisa](https://onedocs.inline0.dev/pt/docs/seo-search)
- [Configuração](https://onedocs.inline0.dev/pt/docs/configuration)
- [API Referência](https://onedocs.inline0.dev/pt/docs/api-reference)