Jamdesk Documentation logo

Verborgene Seiten

Seiten aus Seitenleiste und Suchergebnissen ausblenden, ohne sie zu löschen. Sichtbarkeit per Frontmatter, docs.json oder SEO-Steuerung verwalten.

Einige Seiten gehören nicht in die öffentliche Seitenleiste: Entwürfe, interne Handbücher oder veraltete Leitfäden, auf die Sie weiterhin verlinken müssen. Verborgene Seiten bleiben über ihre direkte URL erreichbar, verschwinden jedoch aus Navigation, Suche, Ihrer Sitemap und dem KI-Kontext, der an LLMs übergeben wird.

Eine einzelne Seite ausblenden

Fügen Sie hidden: true zum Frontmatter der Seite hinzu:

---
title: Internal handbook
hidden: true
---

Die Seite wird normal gerendert, wenn jemand ihre URL aufruft, aber Jamdesk:

  • Entfernt sie aus der Seitenleiste
  • Fügt <meta name="robots" content="noindex, follow"> hinzu, damit Suchmaschinen sie überspringen
  • Schließt sie aus sitemap.xml, llms.txt, llms-full.txt und der Website-Suche aus

Eine ganze Gruppe oder einen Tab ausblenden

Setzen Sie "hidden": true für eine Gruppe oder einen Tab in docs.json:

{
  "navigation": {
    "tabs": [
      {
        "tab": "Public",
        "groups": [{ "group": "Guides", "pages": ["intro", "quickstart"] }]
      },
      {
        "tab": "Internal",
        "hidden": true,
        "groups": [{ "group": "Runbooks", "pages": ["oncall", "postmortems"] }]
      }
    ]
  }
}

Jede Seite unterhalb des verborgenen Knotens übernimmt diese Regel. Dasselbe Flag funktioniert für tabs, groups, anchors, dropdowns, products, languages und versions.

Verborgene Seiten in der Suche behalten

Wenn ein verborgener Tab oder eine verborgene Gruppe aus der Seitenleiste verschwinden, aber weiterhin für die Website-Suche, KI-Antworten und die Sitemap indexiert werden soll, fügen Sie "searchable": true hinzu:

{
  "tab": "Internal",
  "hidden": true,
  "searchable": true,
  "groups": [{ "group": "Runbooks", "pages": ["oncall"] }]
}

hidden: true im Frontmatter einer untergeordneten Seite hat weiterhin Vorrang. searchable öffnet nur Nachfahren wieder, die sich nicht selbst abgemeldet haben.

Eine Seite nur aus der Suche entfernen

Manchmal soll eine Seite in der Seitenleiste bleiben und weiterhin indexierbar sein, aber nicht mehr erscheinen, wenn jemand danach sucht oder eine Frage stellt. Fügen Sie search: false zum Frontmatter hinzu:

---
title: Legacy v1 endpoints
search: false
---

Die Seite behält ihren Platz in der Navigation, Ihrer Sitemap, llms.txt und Ihrem RSS-Feed, und Suchmaschinen indexieren sie weiterhin. Entfernt wird sie von den Abruf-Oberflächen: der Website-Suche, KI-Chat-Antworten und dem MCP-Server.

search: false erfüllt die entgegengesetzte Aufgabe wie hidden: true. hidden entfernt eine Seite aus der Navigation und den Indexierungsoberflächen; search: false lässt all das unverändert und verhindert nur, dass die Seite abgerufen wird. Verwechseln Sie dies nicht mit dem navigationsweiten searchable, das verborgene Seiten wieder in die Suche aufnimmt.

Wie viel von einer Seite indexiert wird

Die Suche indexiert eine Seite nicht als einen einzigen Block. Sie indexiert sie Abschnitt für Abschnitt — jede Überschrift wird zu einem eigenen Sucheintrag, sodass Leser, die nach „Rate limits“ suchen, bei dieser Überschrift statt am Anfang einer langen Seite landen.

Dafür gelten zwei Beschränkungen, die beide automatisch angewendet werden:

LimitWertWas danach passiert
Einträge pro Seite50Abschnitte werden in Seitenreihenfolge indexiert. Sobald der 50. Eintrag verwendet wurde, werden alle verbleibenden Abschnitte aus der Suche ausgeschlossen.
Text pro AbschnittErste 300 ZeichenFormulierungen weiter unten in einem Abschnitt werden nicht gefunden.

Die Seite selbst belegt einen der 50 Plätze, daher werden 49 Abschnitte indexiert.

Die Begrenzung besteht, weil die Suche jeden Eintrag im Verhältnis zum restlichen Index gewichtet. Wenn eine Seite Hunderte von Einträgen erzeugt, verdrängen diese die anderen aus den Ergebnissen — ein automatisch generiertes Änderungsprotokoll kann allein die Hälfte eines Index ausmachen und tatsächlich relevante Seiten von der ersten Ergebnisseite verdrängen.

Eine Seite, die das Limit überschreitet, wird weiterhin vollständig gerendert. Nur ihre späteren Abschnitte können nicht mehr gefunden werden, und nichts auf der Seite weist Ihre Leser darauf hin.

Wenn eine Seite mehr als ungefähr 50 Überschriften enthält, teilen Sie sie entweder in mehrere Seiten auf — was ohnehin für eine bessere Navigation sorgt — oder fügen Sie bei maschinell generierten Seiten, nach denen niemand manuell sucht, search: false hinzu, um die gesamte Seite aus dem Index zu entfernen.

Damit ein Begriff von der Suche richtig gewichtet werden kann, verwenden Sie zuerst den Seitentitel (höchste Gewichtung), dann eine Überschrift und anschließend die Beschreibung. Fließtext wird am niedrigsten gewichtet; pro Abschnitt zählen nur die ersten 300 Zeichen.

seo.metatags.keywords wird nicht in die Website-Suche übernommen. Es erzeugt ein HTML-Tag <meta name="keywords">, das Google laut eigener Aussage bei der Bewertung ignoriert. Es gibt keine Möglichkeit, einer Seite zusätzliche Suchbegriffe zuzuweisen — platzieren Sie die gewünschten Begriffe im Titel, in einer Überschrift oder in der Beschreibung.

Projektweite Steuerungen

Beide Flags befinden sich unter seo in docs.json:

FlagStandardWirkung
seo.indexing"navigable"Nur in Ihrer Navigation aufgeführte Seiten erscheinen in Artefakten. Setzen Sie den Wert auf "all", um jede MDX-Datei in Ihrem Repository einzuschließen.
seo.indexHiddenPagesfalseSetzen Sie den Wert auf true, um Seiten mit hidden: true in Sitemap, llms.txt und Suche einzuschließen und das automatische No-Index-Tag zu entfernen.

Beispiel:

{
  "seo": {
    "indexing": "all"
  }
}

Schnellreferenz

SzenarioFrontmatterdocs.jsonIn Seitenleiste sichtbarDirekte URLIn Sitemap
Normale SeiteaufgeführtJaJaJa
Über Frontmatter verborgenhidden: trueaufgeführtNeinJaNein
Seite nicht in Navigation (verwaist)nicht aufgeführtNeinJaNein
Verborgene Gruppehidden: true für GruppeNeinJaNein
Verborgene, durchsuchbare Gruppehidden: true, searchable: trueNeinJaJa
Nur aus Suche entferntsearch: falseaufgeführtJaJaJa
Projekt aktiviert vollständige IndexierungbeliebigWie obenJaJa

Wann welche Option verwendet wird

  • Entwürfe und Vorschauen: hidden: true im Frontmatter einzelner Seiten
  • Interne Bereiche für ein kleines Team: eine verborgene Gruppe oder ein verborgener Tab
  • Compliance-Dokumente, die öffentlich sein, aber nicht hervorgehoben werden sollen: verborgene Gruppe mit searchable: true
  • Indexierung des gesamten Repositorys nur für KI-Grounding: seo.indexing: "all"
  • Ersetzte Seiten, auf die weiterhin verlinkt und die indexiert werden sollen, die aber nicht über Suche oder KI angezeigt werden sollen: search: false im Frontmatter

Verborgene Seiten sind keine Zugriffskontrolle. Jeder, der die URL kennt, kann sie lesen. Eine echte Zugriffskontrolle finden Sie unter Passwortschutz.