Pereiti prie turinio

SEO ir paieška

Peržiūrėti kaip Markdown Redaguoti per GitHub Dokumentacija: 7b38e05

Paiešką suteikia Fumadocs. Onedocs prideda pagalbines funkcijas svetainei skirtai schemai, robots.txt ir llms.txt failams; visi jie nustatomi kaip Next.js App Router maršrutai. Puslapių metaduomenis ir Open Graph vaizdus žr. onedocs/metadata ir onedocs/og skiltyje API nuoroda.

Onedocs naudoja integruotą Orama paiešką iš Fumadocs. Sukurkite API maršrutą:

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

export const { GET } = createFromSource(source);

Pagal numatytuosius nustatymus RootProvider pridedamas paieškos dialogas užklausia /api/search, todėl papildomai nieko nustatyti nereikia.

Svetainės schema

Sugeneruokite svetainės schemą adresu /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 pateikia svetainės šaknį, tada po vieną URL kiekvienam pages įrašui aplanke /docs. Įrašai, prasidedantys --- (šoninės juostos skirtukais), praleidžiami, o index nukreipia į patį /docs. Įrašai skaitomi tokia tvarka, kokia pateikti, todėl puslapius poaplankiuose reikia įtraukti atskirai, pavyzdžiui, "guides/setup".

Robots.txt

Sugeneruokite robots.txt adresu /robots.txt:

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

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

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

Tai sukuria:

Kodas
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt padeda DI asistentams suprasti jūsų dokumentaciją. Onedocs gali sugeneruoti ir santrauką, ir viso turinio versiją.

Santraukos versija

Sukurkite /llms.txt su puslapių pavadinimais ir aprašymais:

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

Failas prasideda pavadinimu ir aprašymu, išvardija kiekvieną puslapį kaip - Title: URL su jo aprašymu ir baigiasi nuoroda į /llms-full.txt. Abi funkcijos gauna apgaubtą šaltinį iš createLLMsSource, o ne patį Fumadocs šaltinį, ir grąžina pažadą.

Viso turinio versija

Sukurkite /llms-full.txt su visa dokumentacija:

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

Kiekvienas puslapis įrašomas nurodant pavadinimą, URL, aprašymą ir apdorotą Markdown; puslapiai atskiriami ---.

Puslapio tekstas gaunamas iš apdoroto Markdown, priklausančio Fumadocs MDX, kuris pagal numatytuosius nustatymus išjungtas. Be jo llms-full.txt pateikiami tik pavadinimai, URL ir aprašymai (problema Nr. 3). Įjunkite jį faile source.config.ts:

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

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

Konfigūracijos parinktys

Svetainės schemos parinktys

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

Robots parinktys

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

Ką gaunate

Nustatę šiuos maršrutus:

URL Ką daro
/api/search?query=... Paieškos API galinis taškas
/sitemap.xml XML svetainės schema paieškos sistemoms
/robots.txt Robots failas su nuoroda į svetainės schemą
/llms.txt Santrauka DI asistentams
/llms-full.txt Visa dokumentacija DI asistentams