Preskoči na vsebino

SEO in iskanje

Prikaži kot Markdown Uredi na GitHub Dokumentacija za 7b38e05

Iskanje omogoča Fumadocs. Onedocs doda pripomočke za zemljevid spletnega mesta ter datoteki robots.txt in llms.txt; vse so nastavljene kot poti usmerjevalnika App Router Next.js. Za metapodatke strani in slike Open Graph glejte onedocs/metadata in onedocs/og v referenci API.

Onedocs uporablja vgrajeno iskanje Orama iz paketa Fumadocs. Ustvarite pot API:

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

export const { GET } = createFromSource(source);

Pogovorno okno za iskanje, ki ga doda RootProvider, privzeto poizveduje po /api/search, zato dodatna nastavitev ni potrebna.

Zemljevid spletnega mesta

Ustvarite zemljevid spletnega mesta v datoteki /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 navaja korensko mapo spletnega mesta, nato po en URL za vsak vnos v pages pod /docs. Vnosi, ki se začnejo z --- (ločila stranske vrstice), so izpuščeni, index pa se preslika v /docs. Vnosi se obravnavajo takšni, kot so podani, zato strani v podmapah potrebujejo svoje vnose, na primer "guides/setup".

Robots.txt

Ustvarite datoteko robots.txt v /robots.txt:

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

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

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

To ustvari:

Koda
User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt pomaga pomočnikom UI razumeti vašo dokumentacijo. Onedocs lahko ustvari različico s povzetkom in različico s celotno vsebino.

Različica s povzetkom

Ustvarite /llms.txt z naslovi in opisi strani:

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

Datoteka se začne z naslovom in opisom, navede vsako stran v obliki - Title: URL z njenim opisom ter se konča s sklicem na /llms-full.txt. Obe funkciji sprejmeta oviti vir iz createLLMsSource, ne samega vira Fumadocs, in vrneta obljubo.

Različica s celotno vsebino

Ustvarite /llms-full.txt s celotno dokumentacijo:

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

Vsaka stran je zapisana z naslovom, URL, opisom in obdelano vsebino Markdown; strani ločuje ---.

Besedilo strani izvira iz obdelane vsebine Markdown paketa Fumadocs MDX, ki je privzeto izklopljena. Brez nje llms-full.txt vsebuje samo naslove, URL-je in opise (#3). Vklopite jo v source.config.ts:

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

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

Možnosti konfiguracije

Možnosti zemljevida spletnega mesta

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

Možnosti robots

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

Kaj dobite

Po nastavitvi teh poti:

URL Kaj počne
/api/search?query=... Končna točka iskanja API
/sitemap.xml XML zemljevid spletnega mesta za iskalnike
/robots.txt Datoteka robots s sklicem na zemljevid spletnega mesta
/llms.txt Povzetek za pomočnike UI
/llms-full.txt Celotna dokumentacija za pomočnike UI