SEO und Suche

Die Suche stammt von Fumadocs. Onedocs bietet Hilfsfunktionen für Sitemap, robots.txt- und llms.txt-Dateien. Alle sind als Next.js-App-Router-Routen eingerichtet. Informationen zu Seitenmetadaten und Open Graph-Bildern findest du unter onedocs/metadata und onedocs/og in der API-Referenz.

Suche

Onedocs verwendet die integrierte Orama-Suche von Fumadocs. Erstelle eine API-Route:

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

export const { GET } = createFromSource(source);

Der Suchdialog, den RootProvider bereitstellt, fragt standardmäßig /api/search ab. Weitere Einrichtung ist daher nicht erforderlich.

Sitemap

Erstelle eine Sitemap unter /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 ?? [],
  });
}

generateSitemap führt zuerst das Website-Stammverzeichnis und dann für jeden Eintrag in pages unter /docs einen URL-Eintrag auf. Einträge, die mit --- beginnen (Trennzeichen der Seitenleiste), werden übersprungen. index verweist auf /docs selbst. Die Einträge werden wie angegeben gelesen. Daher benötigen Seiten in Unterordnern eigene Einträge, zum Beispiel "guides/setup".

Robots.txt

Erstelle eine robots.txt unter /robots.txt:

import { generateRobots } from "onedocs/seo";

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

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

Dadurch wird Folgendes erstellt:

User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt hilft KI-Assistenten, deine Dokumentation zu verstehen. Onedocs kann sowohl eine Zusammenfassung als auch den vollständigen Inhalt erstellen.

Zusammenfassung

Erstelle /llms.txt mit Seitentiteln und Beschreibungen:

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

Die Datei beginnt mit Titel und Beschreibung, führt jede Seite als - Title: URL samt Beschreibung auf und endet mit einem Verweis auf /llms-full.txt. Beide Funktionen erhalten die umschlossene Quelle aus createLLMsSource, nicht die Fumadocs-Quelle selbst, und geben ein Promise zurück.

Vollständiger Inhalt

Erstelle /llms-full.txt mit der vollständigen Dokumentation:

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

Jede Seite wird mit ihrem Titel, URL, ihrer Beschreibung und dem verarbeiteten Markdown ausgegeben. Zwischen den Seiten steht ---.

Der Seitentext stammt aus dem verarbeiteten Markdown des Fumadocs-MDX, das standardmäßig deaktiviert ist. Ist es ausgeschaltet, enthält llms-full.txt nur Titel, URLs und Beschreibungen (#3). Aktiviere es in source.config.ts:

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

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

Konfigurationsoptionen

Sitemap-Optionen

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

Robots-Optionen

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

Das bekommst du

Nach dem Einrichten dieser Routen: