Gå til indhold

SEO og søgning

Vis som Markdown Rediger på GitHub Dokumentation hos 7b38e05

Søgning leveres af Fumadocs. Onedocs tilføjer hjælpefunktioner til sitemap, robots.txt- og llms.txt-filer, som alle er opsat som ruter i Next.js App Router. Se onedocs/metadata og onedocs/og i API-referencen for sidemetadata og Open Graph-billeder.

Onedocs bruger den indbyggede Orama-søgning fra Fumadocs. Opret en API-rute:

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

export const { GET } = createFromSource(source);

Søgedialogen, som RootProvider tilføjer, forespørger som standard på /api/search, så yderligere opsætning er ikke nødvendig.

Sitemap

Generér et sitemap 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 angiver først webstedets rod og derefter én URL for hver post i pages under /docs. Poster, der begynder med --- (adskillere i sidepanelet), springes over, og index peger på selve /docs. Posterne læses, som de er angivet, så sider i undermapper skal have deres egne poster, f.eks. "guides/setup".

Robots.txt

Generér en robots.txt på /robots.txt:

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

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

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

Dette opretter:

Kode
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt hjælper AI-assistenter med at forstå din dokumentation. Onedocs kan generere både en version med resumé og en version med alt indhold.

Version med resumé

Opret /llms.txt med sidetitler og beskrivelser:

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 begynder med titel og beskrivelse, angiver hver side som - Title: URL med dens beskrivelse og slutter med en henvisning til /llms-full.txt. Begge funktioner tager den indpakkede kilde fra createLLMsSource, ikke selve Fumadocs-kilden, og returnerer et løfte.

Version med alt indhold

Opret /llms-full.txt med den komplette 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" },
  });
}

Hver side skrives med titel, URL, beskrivelse og behandlet Markdown, med --- mellem siderne.

Sidens tekst kommer fra det behandlede Markdown i Fumadocs MDX, som er slået fra som standard. Uden det indeholder llms-full.txt kun titler, URL'er og beskrivelser (#3). Slå det til i source.config.ts:

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

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

Konfigurationsindstillinger

Sitemap-indstillinger

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

Robots-indstillinger

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

Det får du

Når disse ruter er opsat:

URL Hvad den gør
/api/search?query=... Søgeendepunkt for API
/sitemap.xml XML-sitemap til søgemaskiner
/robots.txt Robots-fil med reference til sitemap
/llms.txt Resumé til AI-assistenter
/llms-full.txt Komplet dokumentation til AI-assistenter