Перейти к содержимому

SEO и поиск

Просмотреть как Markdown Редактировать на GitHub Документация по 7b38e05

Поиск реализован на основе Fumadocs. Onedocs добавляет вспомогательные функции для карты сайта, файлов robots.txt и llms.txt — все они настраиваются как маршруты App Router в Next.js. О метаданных страниц и изображениях Open Graph см. onedocs/metadata и onedocs/og в справочнике API Reference.

Onedocs использует встроенный поиск Orama из Fumadocs. Создайте маршрут API:

TypeScript
import { source } from "@/lib/source";
import { createFromSource } from "fumadocs-core/search/server";

export const { GET } = createFromSource(source);

Диалог поиска, добавляемый RootProvider, по умолчанию отправляет запросы к /api/search, поэтому дополнительная настройка не требуется.

Карта сайта

Создайте карту сайта по адресу /sitemap.xml:

TypeScript
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 перечисляет корень сайта, а затем по одному URL для каждой записи в pages в /docs. Записи, начинающиеся с --- (разделители боковой панели), пропускаются, а index указывает на сам /docs. Записи считываются как есть, поэтому для страниц во вложенных папках нужны собственные записи, например "guides/setup".

Robots.txt

Создайте robots.txt по адресу /robots.txt:

TypeScript
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 помогает ИИ-ассистентам понимать документацию. Onedocs может создать и краткую, и полную версии содержимого.

Краткая версия

Создайте /llms.txt с заголовками и описаниями страниц:

TypeScript
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. Обе функции получают обернутый источник из createLLMsSource, а не сам источник Fumadocs, и возвращают промис.

Полная версия содержимого

Создайте /llms-full.txt с полной документацией:

TypeScript
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; между страницами ставится ---.

Текст страниц берется из обработанного Markdown источника Fumadocs MDX, который по умолчанию отключен. Без него llms-full.txt содержит только заголовки, URL и описания (#3). Включите его в source.config.ts:

TypeScript
import { defineDocs } from "fumadocs-mdx/config";

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

Параметры конфигурации

Параметры карты сайта

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

Параметры robots

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

Что вы получаете

После настройки этих маршрутов:

URL Назначение
/api/search?query=... Конечная точка поиска API
/sitemap.xml Карта сайта XML для поисковых систем
/robots.txt Файл robots со ссылкой на карту сайта
/llms.txt Краткое описание для ИИ-ассистентов
/llms-full.txt Полная документация для ИИ-ассистентов