Dokumentation durchsuchen

Die integrierte MiniSearch-Befehlszentrale verwenden und Ergebnisse auf die aktive Sprache begrenzen.

Öffne die Befehlszentrale unter macOS mit ⌘+K, auf anderen Systemen mit Ctrl+K. Ginko Docs indexiert routenbasierte Inhalte mit MiniSearch und kombiniert passende Dokumentations- und Blogeinträge mit Seitennavigation und zuletzt gewählten Zielen.

Den Standardindex verwenden

Der Layer aktiviert MiniSearch. Eine normale Installation benötigt deshalb keine Suchkonfiguration:

nuxt.config.ts

export default defineNuxtConfig({
  extends: ["@lupinum/ginko-docs"],
});

Der Standardindex enthält öffentliche Page-Collections wie docs und, falls aktiviert, blog. Data-Collections wie authors sind keine durchsuchbaren Seiten. Titel, Überschriften und Fließtext bilden die standardmäßigen Suchfelder.

Die Befehlszentrale übergibt die aktive Nuxt-Sprache an useContentSearch(). Englische Leser sehen dadurch englische Treffer, deutsche Leser deutsche Treffer. Ein Sprachwechsel aktualisiert den Suchzustand für die neue Sprache, statt beide Indizes zu vermischen.

MiniSearch abstimmen

Überschreibe nur das Ranking, das du tatsächlich ändern möchtest. Der Layer behält MiniSearch als Engine, während Ginko Content die Suchdatensätze erstellt und ausliefert:

nuxt.config.ts

export default defineNuxtConfig({
  extends: ["@lupinum/ginko-docs"],
  content: {
    search: {
      engine: "minisearch",
      minisearch: {
        fields: ["title", "headings", "content"],
        boost: { title: 4, headings: 2, content: 1 },
        fuzzy: 0.2,
      },
    },
  },
});

fields bestimmt die indexierten Felder, boost deren relative Gewichtung und fuzzy die Fehlertoleranz. Füge ein eigenes Frontmatter-Feld zuerst zu content.search.extraFields hinzu, bevor du es in fields oder storeFields verwendest.

Gut auffindbare Seiten schreiben

Gib jeder Seite einen eindeutigen title und eine konkrete description.
Benenne in Überschriften die Aufgabe oder das Konzept statt allgemeiner Begriffe wie „Überblick“.
Stelle die direkte Antwort an den Anfang der Seite.
Behandle ein Thema pro Seite, damit Treffer zu einem brauchbaren Ziel führen.

Suchrouten stammen aus dem Content-Modell. Pflege keine zweite URL-Liste für die Befehlszentrale.