SEO ja haku

Haku tulee kohteesta Fumadocs. Onedocs tarjoaa apufunktiot sivustokarttaan, robots.txt- ja llms.txt-tiedostoihin. Kaikki on määritetty Next.js App Router -reiteiksi. Sivun metatiedoista ja Open Graph-kuvista kerrotaan onedocs/metadata- ja onedocs/og-kohdissa API Reference-sivulla.

Haku

Onedocs käyttää kohteesta Fumadocs saatavaa sisäänrakennettua Orama-hakua. Luo API-reitti:

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

export const { GET } = createFromSource(source);

Kohteen RootProvider lisäämä hakudialogi hakee oletusarvoisesti kohteesta /api/search, joten muita asetuksia ei tarvita.

Sivustokartta

Luo sivustokartta kohteeseen /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 luettelee ensin sivuston juuren ja sen jälkeen yhden URL-kohteen jokaisesta kohteen pages merkinnästä polussa /docs. Kohteella --- alkavat merkinnät (sivupalkin erottimet) ohitetaan, ja index viittaa itse kohteeseen /docs. Merkinnät luetaan sellaisinaan, joten alikansioiden sivut tarvitsevat omat merkintänsä, esimerkiksi "guides/setup".

Robots.txt

Luo robots.txt kohteeseen /robots.txt:

import { generateRobots } from "onedocs/seo";

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

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

Tämä luo seuraavat tiedostot:

User-Agent: *
Allow: /

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

LLMs.txt

LLMs.txt auttaa tekoälyavustajia ymmärtämään dokumentaatiotasi. Onedocs voi luoda sekä tiivistelmä- että täyden sisällön version.

Tiivistelmäversio

Luo /llms.txt sivujen otsikoilla ja kuvauksilla:

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

Tiedosto alkaa otsikolla ja kuvauksella, luettelee jokaisen sivun muodossa - Title: URL kuvauksineen ja päättyy viittaukseen kohteeseen /llms-full.txt. Molemmat funktiot ottavat kohteen createLLMsSource käärittynä lähteenä, eivät itse Fumadocs-lähteenä, ja palauttavat lupauksen.

Täyden sisällön versio

Luo /llms-full.txt koko dokumentaatiolla:

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

Jokainen sivu kirjoitetaan otsikkona, kohteena URL, kuvauksena ja käsiteltynä Markdown-sisältönä. Sivujen välissä on ---.

Sivun teksti tulee kohteen Fumadocs MDX käsitellystä Markdown-aineistosta, joka on oletuksena pois käytöstä. Ilman sitä llms-full.txt sisältää vain otsikot, URL-osoitteet ja kuvaukset (#3). Ota se käyttöön kohdassa source.config.ts:

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

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

Asetusvaihtoehdot

Sivustokartan asetukset

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

Robots-asetukset

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

Mitä saat

Kun olet määrittänyt nämä reitit: