# SEO & Pesquisa

A pesquisa vem de Fumadocs. Onedocs adiciona auxiliares para o mapa do site, os arquivos robots.txt e llms.txt, todos configurados como rotas do App Router Next.js. Para metadados de página e imagens Open Graph, consulte `onedocs/metadata` e `onedocs/og` na [API Referência](https://onedocs.inline0.dev/pt/docs/api-reference#metadata).

## Pesquisa

Onedocs usa a pesquisa Orama integrada de Fumadocs. Crie uma rota API:

```ts title="src/app/api/search/route.ts"
import { source } from "@/lib/source";
import { createFromSource } from "fumadocs-core/search/server";

export const { GET } = createFromSource(source);
```

A janela de pesquisa adicionada por `RootProvider` consulta `/api/search` por padrão, então não é necessária nenhuma outra configuração.

## Mapa do site

Gere um mapa do site em `/sitemap.xml`:

```ts title="src/app/sitemap.ts"
import { generateSitemap } from "onedocs/seo";
import meta from "../../content/docs/meta.json";

const baseUrl = "https://yourdomain.com";

export default function sitemap() {
  return generateSitemap({
    baseUrl,
    pages: meta.pages ?? [],
  });
}
```

`generateSitemap` lista a raiz do site e, em seguida, um URL para cada entrada em `pages`, dentro de `/docs`. Entradas que começam com `---` (separadores da barra lateral) são ignoradas, e `index` corresponde à própria `/docs`. As entradas são lidas como fornecidas; portanto, páginas em subpastas precisam de entradas próprias, como `"guides/setup"`.

## Robots.txt

Gere um robots.txt em `/robots.txt`:

```ts title="src/app/robots.ts"
import { generateRobots } from "onedocs/seo";

const baseUrl = "https://yourdomain.com";

export default function robots() {
  return generateRobots({ baseUrl });
}
```

Isto cria:

```
User-Agent: *
Allow: /

Host: https://yourdomain.com
Sitemap: https://yourdomain.com/sitemap.xml
```

## LLMs.txt

[LLMs.txt](https://llmstxt.org/) ajuda assistentes de IA a entender sua documentação. Onedocs pode gerar versões resumidas e com o conteúdo completo.

### Versão resumida

Crie `/llms.txt` com os títulos e as descrições das páginas:

```ts title="src/app/llms.txt/route.ts"
import { createLLMsSource, generateLLMsText } from "onedocs/llms";
import { source } from "@/lib/source";
import config from "../../../onedocs.config";

export async function GET() {
  const llmsSource = createLLMsSource(source);
  const text = await generateLLMsText(llmsSource, {
    title: config.title,
    description: config.description,
  });

  return new Response(text, {
    headers: { "Content-Type": "text/plain; charset=utf-8" },
  });
}
```

O arquivo começa com o título e a descrição, lista cada página como `- Title: URL` com sua descrição e termina com uma referência a `/llms-full.txt`. Ambas as funções recebem a fonte envolvida de `createLLMsSource`, não a própria fonte Fumadocs, e retornam uma promessa.

### Versão com conteúdo completo

Crie `/llms-full.txt` com a documentação completa:

```ts title="src/app/llms-full.txt/route.ts"
import { createLLMsSource, generateLLMsFullText } from "onedocs/llms";
import { source } from "@/lib/source";

export async function GET() {
  const llmsSource = createLLMsSource(source);
  const text = await generateLLMsFullText(llmsSource);

  return new Response(text, {
    headers: { "Content-Type": "text/plain; charset=utf-8" },
  });
}
```

Cada página é escrita com o título, URL, a descrição e o conteúdo processado de Markdown, com `---` entre as páginas.

O texto das páginas vem do Markdown processado do Fumadocs MDX, que está desativado por padrão. Sem essa opção, `llms-full.txt` contém apenas títulos, URLs e descrições ([#3](https://github.com/inline0/onedocs/issues/3)). Ative-a em `source.config.ts`:

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

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

## Opções de configuração

### Opções do mapa do site

```ts
generateSitemap({
  baseUrl: "https://yourdomain.com",
  pages: ["index", "getting-started", "configuration"],
  docsPath: "/docs", // Default: "/docs"
});
```

### Opções do robots

```ts
generateRobots({
  baseUrl: "https://yourdomain.com",
  sitemapPath: "/sitemap.xml", // Default: "/sitemap.xml"
});
```

## O que você recebe

Depois de configurar estas rotas:

| URL | O que faz |
|-----|--------------|
| `/api/search?query=...` | Endpoint de pesquisa API |
| `/sitemap.xml` | Mapa do site XML para mecanismos de busca |
| `/robots.txt` | Arquivo Robots com referência ao mapa do site |
| `/llms.txt` | Resumo para assistentes de IA |
| `/llms-full.txt` | Documentação completa para assistentes de IA |