Preskočiť na obsah

SEO a vyhľadávanie

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 7b38e05

Vyhľadávanie zabezpečuje Fumadocs. Onedocs pridáva pomocné funkcie pre mapu webu, súbory robots.txt a llms.txt, ktoré sú všetky nastavené ako trasy App Router Next.js. Informácie o metadátach stránok a obrázkoch Open Graph nájdete v onedocs/metadata a onedocs/og v API Referencii.

Onedocs používa vstavané vyhľadávanie Orama z Fumadocs. Vytvorte trasu API:

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

export const { GET } = createFromSource(source);

Dialóg vyhľadávania, ktorý pridáva RootProvider, predvolene vyhľadáva v /api/search, takže ďalšie nastavenie nie je potrebné.

Mapa webu

Vytvorte mapu webu na adrese /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 uvádza koreň webu a potom jednu položku URL pre každý záznam v pages v rámci /docs. Záznamy začínajúce na --- (oddeľovače v bočnom paneli) sa preskakujú a index sa mapuje samo na seba, /docs. Záznamy sa čítajú v zadanom poradí, takže stránky v podpriečinkoch musia mať vlastné záznamy, napríklad "guides/setup".

Robots.txt

Vytvorte súbor robots.txt na adrese /robots.txt:

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

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

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

Tým sa vytvorí:

Kód
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt pomáha asistentom AI porozumieť vašej dokumentácii. Onedocs dokáže vytvoriť súhrnnú aj úplnú verziu obsahu.

Súhrnná verzia

Vytvorte /llms.txt s názvami a opismi stránok:

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

Súbor sa začína názvom a opisom, uvádza každú stránku ako - Title: URL s jej opisom a končí odkazom na /llms-full.txt. Obe funkcie prijímajú zabalený zdroj z createLLMsSource, nie samotný zdroj Fumadocs, a vracajú prísľub.

Verzia s úplným obsahom

Vytvorte /llms-full.txt s úplnou dokumentáciou:

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ždá stránka je zapísaná ako názov, URL, opis a spracované Markdown, pričom stránky oddeľuje ---.

Text stránok pochádza zo spracovaného Markdown v Fumadocs MDX, ktoré je predvolene vypnuté. Bez neho llms-full.txt obsahuje iba názvy, adresy URL a opisy (#3). Zapnite ho v source.config.ts:

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

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

Možnosti konfigurácie

Možnosti mapy webu

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

Možnosti súboru robots

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

Čo získate

Po nastavení týchto trás:

URL Čo robí
/api/search?query=... Koncový bod vyhľadávania API
/sitemap.xml Mapa webu XML pre vyhľadávače
/robots.txt Súbor robots s odkazom na mapu webu
/llms.txt Súhrn pre asistentov AI
/llms-full.txt Úplná dokumentácia pre asistentov AI