Hoppa till innehåll

SEO och sökning

Visa som Markdown Redigera på GitHub Dokumentation på 7b38e05

Sökningen kommer från Fumadocs. Onedocs lägger till hjälp för webbplatskartan och filerna robots.txt och llms.txt, som alla konfigureras som rutter i Next.js App Router. Se onedocs/metadata och onedocs/og i referensen för Open Graph-bilder och sidmetadata i API-referensen.

Onedocs använder den inbyggda Orama-sökningen från Fumadocs. Skapa en API-rutt:

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

export const { GET } = createFromSource(source);

Sökrutan som RootProvider lägger till söker som standard i /api/search, så ingen annan konfiguration behövs.

Webbplatskarta

Skapa en webbplatskarta på /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 listar webbplatsens rot först och sedan en URL för varje post i pages under /docs. Poster som börjar med --- (avgränsare i sidofältet) hoppas över, och index mappas till /docs självt. Poster läses som de anges, så sidor i undermappar behöver egna poster, till exempel "guides/setup".

Robots.txt

Skapa en robots.txt på /robots.txt:

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

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

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

Detta skapar:

Kod
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt hjälper AI-assistenter att förstå dokumentationen. Onedocs kan generera både sammanfattningar och versioner med hela innehållet.

Sammanfattningsversion

Skapa /llms.txt med sidtitlar och beskrivningar:

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

Filen börjar med titeln och beskrivningen, listar varje sida som - Title: URL med dess beskrivning och avslutas med en hänvisning till /llms-full.txt. Båda funktionerna tar den omslutna källan från createLLMsSource, inte själva källan Fumadocs, och returnerar ett promise.

Version med hela innehållet

Skapa /llms-full.txt med komplett dokumentation:

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

Varje sida skrivs med sin titel, URL, beskrivning och bearbetade Markdown, med --- mellan sidorna.

Sidtexten hämtas från det bearbetade Markdown i Fumadocs MDX, som är inaktiverat som standard. Utan det innehåller llms-full.txt bara titlar, URL:er och beskrivningar (#3). Aktivera det i source.config.ts:

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

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

Konfigurationsalternativ

Alternativ för webbplatskartan

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

Alternativ för robots.txt

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

Det här får du

När du har konfigurerat de här rutterna:

URL Vad den gör
/api/search?query=... Slutpunkt för sökning API
/sitemap.xml XML-webbplatskarta för sökmotorer
/robots.txt Robots-fil med hänvisning till webbplatskartan
/llms.txt Sammanfattning för AI-assistenter
/llms-full.txt Dokumentation i sin helhet för AI-assistenter