SEO és keresés

A keresést a Fumadocs biztosítja. A Onedocs segédfüggvényeket ad a webhelytérképhez, a robots.txt és llms.txt fájlokhoz; ezek mind a Next.js App Router útvonalaiként vannak beállítva. Az oldalmetaadatokról és a Open Graph képekről lásd a onedocs/metadata és onedocs/og részt az API dokumentációs referenciában.

Keresés

A Onedocs a Fumadocs beépített Orama keresőjét használja. Hozzon létre egy API útvonalat:

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

export const { GET } = createFromSource(source);

A RootProvider által hozzáadott keresőablak alapértelmezés szerint a /api/search adatai között keres, ezért nincs szükség további beállításra.

Webhelytérkép

Hozzon létre webhelytérképet itt: /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 ?? [],
  });
}

A generateSitemap felsorolja a webhely gyökerét, majd a pages minden bejegyzéséhez egy URL elemet a /docs alatt. A --- karakterekkel kezdődő bejegyzéseket (oldalsáv-elválasztókat) kihagyja, a index pedig közvetlenül a /docs elemhez rendelődik. A bejegyzéseket változatlanul olvassa be, ezért az almappákban lévő oldalakhoz külön bejegyzés kell, például: "guides/setup".

Robots.txt

Hozzon létre egy robots.txt fájlt itt: /robots.txt:

import { generateRobots } from "onedocs/seo";

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

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

Ez a következőket hozza létre:

User-Agent: *
Allow: /

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

LLMs.txt

A LLMs.txt segít az AI-asszisztenseknek megérteni a dokumentációt. A Onedocs összefoglaló és teljes tartalmú változatot is létre tud hozni.

Összefoglaló változat

Hozza létre a /llms.txt fájlt az oldalcímekkel és -leírásokkal:

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

A fájl a címmel és a leírással kezdődik, minden oldalt - Title: URL formájában, a leírásával együtt sorol fel, majd a /llms-full.txt elemre mutató hivatkozással zárul. Mindkét függvény a createLLMsSource által becsomagolt forrást kapja meg, nem magát a Fumadocs forrást, és egy Promise-t ad vissza.

Teljes tartalmú változat

Hozza létre a /llms-full.txt fájlt a teljes dokumentációval:

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

Minden oldal címmel, URL értékkel és leírással, majd feldolgozott Markdown tartalommal jelenik meg; az oldalakat --- választja el.

Az oldalszöveg a Fumadocs MDX feldolgozott Markdown tartalmából származik, amely alapértelmezés szerint ki van kapcsolva. Nélküle a llms-full.txt csak címeket, URL-eket és leírásokat tartalmaz (#3). Kapcsolja be a source.config.ts fájlban:

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

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

Konfigurációs lehetőségek

Webhelytérkép-beállítások

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

Robots-beállítások

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

Mit kínál

Ezen útvonalak beállítása után: