Zum Inhalt springen
Das ist die Dokumentation für Clay 3.x. Zur neuesten Version (5.x)
Auf dieser Seite

Suche

Jede Clay-Seite hat eine Volltextsuche, ohne Einrichtung und ohne externen Dienst. Clay baut den Suchindex zusammen mit der Seite, und der Browser lädt ihn, sobald jemand zum ersten Mal sucht.

#Die Suche öffnen

Kürzel Aktion
Strg + K oder ⌘ + K Suche öffnen oder schließen
/ Suche öffnen (wenn du nicht gerade in einem Feld tippst)
↑ ↓ Durch die Ergebnisse gehen
⏎ Das gewählte Ergebnis öffnen
Esc Suche schließen

Auch die Lupe in der Navigationsleiste öffnet sie.

#Was gefunden wird

Der Index umfasst jede Seite, aufgeteilt in Abschnitte an jeder ##- und ###-Überschrift. Ein Ergebnis führt direkt zu seinem Abschnitt, nicht nur zur Seite, und zeigt den passenden Text mit markierten Suchwörtern. Nach dem Öffnen bleiben die Wörter auf der Seite markiert, und die Seite springt zum ersten Treffer.

Ergebnisse werden danach sortiert, wo die Wörter vorkommen, das Beste zuerst:

  1. Seitentitel,
  2. Überschriften von Abschnitten,
  3. Ordnernamen (der Pfad über einem Ergebnis, etwa „Anleitungen › Fortgeschritten“),
  4. der Text,
  5. Codeblöcke.

#Tippen und Tippfehler

  • Jedes Wort muss passen. „github pages“ findet Abschnitte mit beiden Wörtern; hat kein Abschnitt alle, zeigt Clay Abschnitte mit einem davon.
  • Das letzte Wort wird ergänzt, während du tippst: „veröff“ findet „Veröffentlichen“.
  • Kleine Tippfehler werden verziehen, in Wörtern ab vier Buchstaben: „Konfiguartion“ findet „Konfiguration“.

#Zuletzt besuchte Seiten

Bevor du tippst, listet die Suche die Seiten, die du zuletzt über sie geöffnet hast. Sie bleiben nur in deinem Browser, pro Seite, und werden nirgendwohin gesendet.

#Versionen und Sprachen

Jede Version und Sprache hat ihren eigenen Index, und die Suche sucht in dem, den du gerade liest: Ergebnisse führen nie in eine andere Version oder Sprache.

Tipp

Gute Überschriften ergeben gute Suchergebnisse. Einen Abschnitt „Auf GitHub Pages veröffentlichen“ findet jeder, der danach sucht; einen Abschnitt „Schritt 3“ nicht.