Przejdź do treści

SEO i wyszukiwanie

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 7b38e05

Wyszukiwanie zapewnia Fumadocs. Onedocs dodaje funkcje pomocnicze do mapy witryny oraz plików robots.txt i llms.txt, skonfigurowane jako trasy App Router Next.js. Informacje o metadanych stron i obrazach Open Graph znajdziesz w sekcjach onedocs/metadata i onedocs/og w API—dokumentacji referencyjnej.

Onedocs domyślnie korzysta z wbudowanej wyszukiwarki Orama z Fumadocs. Utwórz trasę API:

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

export const { GET } = createFromSource(source);

Okno wyszukiwania dodawane przez RootProvider domyślnie przeszukuje /api/search, więc nie trzeba niczego dodatkowo konfigurować.

Mapa witryny

Wygeneruj mapę witryny pod adresem /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 zawiera katalog główny witryny, a następnie jeden URL dla każdego wpisu w pages w ramach /docs. Wpisy zaczynające się od --- (separatory paska bocznego) są pomijane, a index wskazuje na samo /docs. Wpisy są odczytywane w podanej postaci, więc strony w podfolderach wymagają własnych wpisów, na przykład "guides/setup".

Robots.txt

Wygeneruj robots.txt pod adresem /robots.txt:

TypeScript
import { generateRobots } from "onedocs/seo";

const baseUrl = "https://yourdomain.com";

export default function robots() {
  return generateRobots({ baseUrl });
}

To tworzy:

Kod
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt pomaga asystentom AI zrozumieć dokumentację. Onedocs może wygenerować zarówno wersję skróconą, jak i pełną.

Wersja skrócona

Utwórz /llms.txt z tytułami i opisami stron:

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

Plik zaczyna się od tytułu i opisu, zawiera listę każdej strony jako - Title: URL wraz z jej opisem, a kończy się odwołaniem do /llms-full.txt. Obie funkcje pobierają opakowane źródło z createLLMsSource, a nie samo źródło Fumadocs, i zwracają obietnicę.

Wersja pełna

Utwórz /llms-full.txt z pełną dokumentacją:

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

Każda strona jest zapisywana jako tytuł, URL, opis i przetworzona zawartość Markdown, a strony są rozdzielane przez ---.

Tekst stron pochodzi z przetworzonego Markdown w Fumadocs MDX; ta opcja jest domyślnie wyłączona. Bez niej llms-full.txt zawiera tylko tytuły, adresy URL i opisy (#3). Włącz ją w source.config.ts:

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

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

Opcje konfiguracji

Opcje mapy witryny

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

Opcje pliku robots

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

Co zyskujesz

Po skonfigurowaniu tych tras:

URL Działanie
/api/search?query=... Punkt końcowy wyszukiwania API
/sitemap.xml XML mapa witryny dla wyszukiwarek
/robots.txt Plik robots z odwołaniem do mapy witryny
/llms.txt Podsumowanie dla asystentów AI
/llms-full.txt Pełna dokumentacja dla asystentów AI