Pāriet uz saturu

SEO un meklēšana

Skatīt kā Markdown Rediģēt vietnē GitHub Dokumentācija vietnē 7b38e05

Meklēšanu nodrošina Fumadocs. Onedocs pievieno palīgfunkcijas vietnes kartei, robots.txt un llms.txt failiem; tās visas ir iestatītas kā Next.js App Router maršruti. Informāciju par lapu metadatiem un Open Graph attēliem skatiet sadaļās onedocs/metadata un onedocs/og API uzziņu materiālā.

Onedocs izmanto iebūvēto Orama meklēšanu no Fumadocs. Izveidojiet API maršrutu:

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

export const { GET } = createFromSource(source);

Meklēšanas dialogā, ko pievieno RootProvider, pēc noklusējuma tiek vaicāts /api/search, tāpēc papildu iestatīšana nav vajadzīga.

Vietnes karte

Ģenerējiet vietnes karti adresē /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 uzskaita vietnes sakni un pēc tam vienu URL katram ierakstam sadaļā pages mapē /docs. Ieraksti, kas sākas ar --- (sānjoslas atdalītāji), tiek izlaisti, un index norāda uz /docs pašu. Ieraksti tiek nolasīti tieši tā, kā norādīts, tāpēc lapām apakšmapēs vajadzīgi atsevišķi ieraksti, piemēram, "guides/setup".

Robots.txt

Ģenerējiet robots.txt adresē /robots.txt:

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

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

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

Tas izveido:

Kods
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt palīdz AI asistentiem izprast jūsu dokumentāciju. Onedocs var ģenerēt gan kopsavilkuma, gan pilna satura versiju.

Kopsavilkuma versija

Izveidojiet /llms.txt ar lapu nosaukumiem un aprakstiem:

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

Fails sākas ar nosaukumu un aprakstu, uzskaita katru lapu kā - Title: URL ar tās aprakstu un beidzas ar norādi uz /llms-full.txt. Abas funkcijas pieņem iesaiņotu avotu no createLLMsSource, nevis pašu Fumadocs avotu, un atgriež solījumu.

Pilna satura versija

Izveidojiet /llms-full.txt ar pilnu dokumentāciju:

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

Katra lapa tiek pierakstīta šādā secībā: tās nosaukums, URL, apraksts un apstrādātais Markdown; starp lapām tiek ievietots ---.

Lapas teksts tiek iegūts no apstrādātā Markdown, ko nodrošina Fumadocs MDX; pēc noklusējuma tas ir izslēgts. Ja tas nav ieslēgts, llms-full.txt satur tikai nosaukumus, URL un aprakstus (#3). Ieslēdziet to failā source.config.ts:

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

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

Konfigurācijas opcijas

Vietnes kartes opcijas

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

Robots opcijas

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

Ko iegūsiet

Pēc šo maršrutu iestatīšanas:

URL Darbība
/api/search?query=... Meklēšanas API galapunkts
/sitemap.xml XML vietnes karte meklētājprogrammām
/robots.txt Robots fails ar vietnes kartes atsauci
/llms.txt Kopsavilkums AI asistentiem
/llms-full.txt Pilna dokumentācija AI asistentiem