
# SEO ja haku

Haku tulee kohteesta Fumadocs. Onedocs tarjoaa apufunktiot sivustokarttaan, robots.txt- ja llms.txt-tiedostoihin. Kaikki on määritetty Next.js App Router -reiteiksi. Sivun metatiedoista ja Open Graph-kuvista kerrotaan `onedocs/metadata`- ja `onedocs/og`-kohdissa [API Reference](https://onedocs.inline0.dev/fi/docs/api-reference#metadata)-sivulla.

## Haku

Onedocs käyttää kohteesta Fumadocs saatavaa sisäänrakennettua Orama-hakua. Luo API-reitti:

```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);
```

Kohteen `RootProvider` lisäämä hakudialogi hakee oletusarvoisesti kohteesta `/api/search`, joten muita asetuksia ei tarvita.

## Sivustokartta

Luo sivustokartta kohteeseen `/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` luettelee ensin sivuston juuren ja sen jälkeen yhden URL-kohteen jokaisesta kohteen `pages` merkinnästä polussa `/docs`. Kohteella `---` alkavat merkinnät (sivupalkin erottimet) ohitetaan, ja `index` viittaa itse kohteeseen `/docs`. Merkinnät luetaan sellaisinaan, joten alikansioiden sivut tarvitsevat omat merkintänsä, esimerkiksi `"guides/setup"`.

## Robots.txt

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

Tämä luo seuraavat tiedostot:

```
User-Agent: *
Allow: /

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

## LLMs.txt

[LLMs.txt](https://llmstxt.org/) auttaa tekoälyavustajia ymmärtämään dokumentaatiotasi. Onedocs voi luoda sekä tiivistelmä- että täyden sisällön version.

### Tiivistelmäversio

Luo `/llms.txt` sivujen otsikoilla ja kuvauksilla:

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

Tiedosto alkaa otsikolla ja kuvauksella, luettelee jokaisen sivun muodossa `- Title: URL` kuvauksineen ja päättyy viittaukseen kohteeseen `/llms-full.txt`. Molemmat funktiot ottavat kohteen `createLLMsSource` käärittynä lähteenä, eivät itse Fumadocs-lähteenä, ja palauttavat lupauksen.

### Täyden sisällön versio

Luo `/llms-full.txt` koko dokumentaatiolla:

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

Jokainen sivu kirjoitetaan otsikkona, kohteena URL, kuvauksena ja käsiteltynä Markdown-sisältönä. Sivujen välissä on `---`.

Sivun teksti tulee kohteen Fumadocs MDX käsitellystä Markdown-aineistosta, joka on oletuksena pois käytöstä. Ilman sitä `llms-full.txt` sisältää vain otsikot, URL-osoitteet ja kuvaukset ([#3](https://github.com/inline0/onedocs/issues/3)). Ota se käyttöön kohdassa `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,
    },
  },
});
```

## Asetusvaihtoehdot

### Sivustokartan asetukset

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

### Robots-asetukset

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

## Mitä saat

Kun olet määrittänyt nämä reitit:

| URL | Mitä se tekee |
|-----|--------------|
| `/api/search?query=...` | Haun API-päätepiste |
| `/sitemap.xml` | XML-sivustokartta hakukoneille |
| `/robots.txt` | Robots-tiedosto, jossa on viittaus sivustokarttaan |
| `/llms.txt` | Tiivistelmä tekoälyavustajille |
| `/llms-full.txt` | Täysi dokumentaatio tekoälyavustajille |
