SEO и търсене

Търсенето се осигурява от Fumadocs. Onedocs добавя помощни функции за картата на сайта и файловете robots.txt и llms.txt, настроени като маршрути на Next.js App Router. За метаданните на страниците и изображенията Open Graph вижте onedocs/metadata и onedocs/og в справочника за API.

Търсене

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

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

export const { GET } = createFromSource(source);

Диалоговият прозорец за търсене, добавен от RootProvider, по подразбиране изпраща заявки към /api/search, така че не е нужна друга настройка.

Карта на сайта

Генерирайте карта на сайта на /sitemap.xml:

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:

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

Версия с резюме

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

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, и връщат promise.

Версия с пълното съдържание

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

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:

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

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

Опции за конфигурация

Опции за картата на сайта

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

Опции за robots файла

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

Какво получавате

След като настроите тези маршрути: