# SEO ja otsing

Otsing pärineb paketist Fumadocs. Onedocs lisab abifunktsioonid saidikaardi, robots.txt ja llms.txt failide jaoks; kõik on seadistatud Next.js App Routeri marsruutidena. Lehe metaandmete ja Open Graph piltide kohta vaata jaotisi `onedocs/metadata` ja `onedocs/og` [API viites](https://onedocs.inline0.dev/et/docs/api-reference#metadata).

## Otsing

Onedocs kasutab sisseehitatud Orama otsingut paketist Fumadocs. Loo marsruut 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);
```

`RootProvider` lisatav otsingudialoog päringutab vaikimisi `/api/search`-i, seega pole lisaseadistust vaja.

## Saidikaart

Genereeri saidikaart asukohas `/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` loetleb saidi juurkausta ja seejärel iga kirje kohta ühe URL asukohas `/docs` oleva faili `pages` järgi. Kirjed, mis algavad märgiga `---` (külgriba eraldajad), jäetakse vahele, ning `index` viitab iseendale `/docs`. Kirjeid kasutatakse esitatud kujul, seega vajavad alamkaustades olevad lehed eraldi kirjeid, näiteks `"guides/setup"`.

## Robots.txt

Genereeri robots.txt asukohas `/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 });
}
```

See loob:

```
User-Agent: *
Allow: /

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

## LLMs.txt

[LLMs.txt](https://llmstxt.org/) aitab AI-assistentidel sinu dokumentatsioonist aru saada. Onedocs saab luua nii kokkuvõtte kui ka täissisu versiooni.

### Kokkuvõtteversioon

Loo `/llms.txt` koos lehtede pealkirjade ja kirjeldustega:

```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" },
  });
}
```

Fail algab pealkirja ja kirjeldusega, loetleb iga lehe kujul `- Title: URL` koos selle kirjeldusega ning lõpeb viitega objektile `/llms-full.txt`. Mõlemad funktsioonid võtavad mähitud lähte `createLLMsSource`-st, mitte otse allikast Fumadocs, ja tagastavad lubaduse.

### Täissisu versioon

Loo `/llms-full.txt` koos täieliku dokumentatsiooniga:

```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" },
  });
}
```

Iga leht kirjutatakse kujul: pealkiri, URL, kirjeldus ja töödeldud Markdown, lehtede vahel on `---`.

Lehe tekst pärineb Fumadocs MDX töödeldud Markdown-st, mis on vaikimisi välja lülitatud. Ilma selleta sisaldab `llms-full.txt` ainult pealkirju, URL-e ja kirjeldusi ([#3](https://github.com/inline0/onedocs/issues/3)). Lülita see sisse jaotises `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,
    },
  },
});
```

## Seadistusvalikud

### Saidikaardi valikud

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

### Robotite valikud

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

## Mida saate

Pärast nende marsruutide seadistamist:

| URL | Mida see teeb |
|-----|--------------|
| `/api/search?query=...` | Otsingu API lõpp-punkt |
| `/sitemap.xml` | XML saidikaart otsingumootoritele |
| `/robots.txt` | Robotite fail viitega saidikaardile |
| `/llms.txt` | AI-assistentide kokkuvõte |
| `/llms-full.txt` | AI-assistentide täielik dokumentatsioon |