
# SEOと検索

検索はFumadocsが提供します。Onedocsにはサイトマップ、robots.txt、llms.txtファイル用のヘルパーがあり、すべてNext.js App Routerのルートとしてセットアップできます。ページメタデータとOpen Graph画像については、[APIリファレンス](https://onedocs.inline0.dev/ja/docs/api-reference#metadata)の`onedocs/metadata`と`onedocs/og`を参照してください。

## 検索

OnedocsはFumadocsに組み込まれたOrama検索を使います。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`が追加する検索ダイアログは、デフォルトで`/api/search`にクエリを送るため、追加の設定は不要です。

## サイトマップ

`/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`は最初にサイトのルートを列挙し、その後、`/docs`にある`pages`の各エントリーにつきURLを1つずつ追加します。`---`で始まるエントリー（サイドバーの区切り）はスキップされ、`index`は`/docs`自体に対応します。エントリーは指定どおりに読み込まれるため、サブフォルダー内のページには個別のエントリーが必要です（例：`"guides/setup"`）。

## Robots.txt

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

次のファイルが作成されます。

```
User-Agent: *
Allow: /

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

## LLMs.txt

[LLMs.txt](https://llmstxt.org/)を使うと、AIアシスタントがドキュメントを理解しやすくなります。Onedocsでは要約版と全文版の両方を生成できます。

### 要約版

ページタイトルと説明を含む`/llms.txt`を作成します。

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

ファイルはタイトルと説明で始まり、説明付きで各ページを`- Title: URL`として列挙し、`/llms-full.txt`への参照で終わります。どちらの関数もFumadocsソースそのものではなく、`createLLMsSource`でラップしたソースを受け取り、Promiseを返します。

### 全文版

ドキュメント全体を含む`/llms-full.txt`を作成します。

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

各ページは、タイトル、URL、説明、処理済みMarkdownの順に記述され、ページ間には`---`が入ります。

ページのテキストは、Fumadocs MDXで処理されたMarkdownから取得します。これはデフォルトでは無効です。有効にしない場合、`llms-full.txt`にはタイトル、URL、説明のみが含まれます（[#3](https://github.com/inline0/onedocs/issues/3)）。`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,
    },
  },
});
```

## 設定オプション

### サイトマップのオプション

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

### Robotsのオプション

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

## できること

これらのルートをセットアップすると、次のようになります。

| URL | 機能 |
|-----|--------------|
| `/api/search?query=...` | 検索APIエンドポイント |
| `/sitemap.xml` | 検索エンジン向けXMLサイトマップ |
| `/robots.txt` | サイトマップ参照を含むRobotsファイル |
| `/llms.txt` | AIアシスタント向けの要約 |
| `/llms-full.txt` | AIアシスタント向けのドキュメント全文 |
