Frontmatter

Frontmatter hält seitenspezifische Entscheidungen direkt bei der Seite. Nutze es für Titel, Beschreibung, Seitenleistenreihenfolge, Layout, Inhaltsverzeichnis, Bearbeitungslinks und Build-Ausgabe.

Ardo normalisiert dokumentierte Frontmatter-Felder einmal für Routenmetadaten, Seitenleisten, Suche, Weiterleitungen, Sitemap und LLM-Ausgabe. Ungültige Werte werden beim Produktionsbuild mit der Quelldatei gemeldet. Unbekannte Felder bleiben standardmäßig kompatibel, können aber über die Konfiguration sichtbar oder blockierend werden.

Grundlegende Verwendung

---
title: My Page Title
description: A description for SEO
---
# Page Content

Your content here...

Verfügbare Optionen

title

• Typ:string

Der Seitentitel. Er erscheint im Browser-Tab und als <h1>, falls der Inhalt keine entsprechende Überschrift enthält.

---
title: Getting Started
---

description

• Typ:string

Die Seitenbeschreibung für SEO-Meta-Tags.

---
description: Learn how to get started with Ardo
---

Ardo zeigt description auch als Einleitung unter dem Seitentitel an. Enthält der erste Absatz denselben normalisierten Text, entfällt die Einleitung, damit der Satz nicht doppelt erscheint.

lede

• Typ:boolean
• Standard:true

Setze lede: false, wenn description nur in den Metadaten stehen soll.

---
title: Getting Started
description: Learn how to get started with Ardo
lede: false
---

Metadaten für soziale Netzwerke

Markdown-Routen ohne eigenen meta-Export erhalten aus Frontmatter und Website-Konfiguration generierte Browser-, Canonical-, Open-Graph- und Twitter-Metadaten.

---
title: Getting Started
description: Learn how to get started with Ardo
canonical: https://example.com/guide/getting-started
ogTitle: Start building with Ardo
ogDescription: A focused guide to Ardo projects
ogImage: /social/getting-started.png
ogType: article
twitterCard: summary_large_image
twitterDescription: A focused guide to Ardo projects
twitterImage: /social/getting-started-twitter.png
twitterTitle: Start building with Ardo
---

• canonical überschreibt die generierte kanonische URL und og:url.
• ogTitle, ogDescription, ogImage und ogType steuern Open Graph.
• twitterTitle, twitterDescription, twitterImage und twitterCard steuern Twitter Cards.
• Relative Canonical- und Bildwerte werden mit siteUrl absolut. Ohne siteUrl entfallen relative URL-Tags.

layout

• Typ:"bare" | "default"
• Standard:"default"

bare entfernt Seitenleiste und rechte Seitenspalte wie auf einer Landingpage; die Kopfzeile zeigt die Suche als Icon. default ist das Dokumentationslayout mit Seitenleiste und Inhaltsverzeichnis. Die Startseite unter / nutzt immer das Bare-Layout.

---
layout: bare
---

sidebar

• Typ:boolean | "leaf"
• Standard:true

sidebar: false entfernt die Seite aus der generierten Seitenleiste. Sie wird weiterhin gebaut und bleibt per Link erreichbar.

---
sidebar: false
---

Nutze sidebar: leaf in index.md oder index.mdx, um das Verzeichnis als einzelnen Link ohne automatisch aufgelistete Unterseiten anzuzeigen.

order

• Typ:number

Steuert die Reihenfolge innerhalb desselben Verzeichnisses. Einträge mit order stehen vor unsortierten Einträgen; diese werden alphabetisch sortiert. Die Links zur vorherigen und nächsten Seite folgen derselben Reihenfolge.

---
title: Getting Started
order: 1
---

Metadaten eines Verzeichnisindex

Enthält ein Routenverzeichnis index.md oder index.mdx, konfiguriert dessen Frontmatter die von ArdoGeneratedSidebar erzeugte Verzeichnisgruppe.

---
title: Guide
order: 10
collapsed: false
---

• title setzt die Gruppenbezeichnung.
• order sortiert die Gruppe unter benachbarten Seiten und Gruppen. Ordner auf oberster Ebene werden stattdessen zu Abschnitten; ordne sie mit sidebar.sectionOrder.
• collapsed legt den anfänglichen Einklappzustand fest. Auf enthaltenen Seiten öffnet sich auch eine eingeklappte Gruppe.

outline

• Typ:boolean
• Standard:true

Setze outline: false, um das Inhaltsverzeichnis der Seite auszublenden. Die aufgeführten Überschriftenebenen gelten websiteweit und werden mit markdown.toc.level in ardo.config.ts festgelegt.

---
outline: false
---

editLink

• Typ:boolean
• Standard:true

Legt fest, ob der Link zum Bearbeiten der Seite erscheint.

---
editLink: false
---

lastUpdated

• Typ:boolean
• Standard:true

Legt fest, ob der Zeitpunkt der letzten Aktualisierung erscheint.

---
lastUpdated: false
---

Optionen für die Build-Ausgabe

sitemap

• Typ:boolean
• Standard:true

Entfernt eine Markdown-Route aus der generierten Sitemap, ohne sie aus der Navigation auszublenden.

---
title: Internal Migration Notes
sitemap: false
---

llms

• Typ:boolean
• Standard:true

Entfernt eine Markdown-Route aus /llms.txt und /llms-full.txt. Das eignet sich für Seiten, die Menschen helfen, aber einen einzelnen Modellkontext überladen, etwa generierte Änderungsprotokolle oder umfangreiche Testreferenzen.

---
title: Fixture Catalog
llms: false
---

redirectFrom

• Typ:string | string[]

Erzeugt statische Weiterleitungen von alten Pfaden zu dieser Seite. Nutze eine Zeichenfolge für einen alten Pfad oder ein Array für mehrere frühere Adressen.

---
title: Configuration
redirectFrom:
  - /config
  - /guide/options
---

Ardo kombiniert Seitenweiterleitungen mit der Option redirects in ardo.config.ts und erzeugt beim Produktionsbuild passende Dateien für die Hoster.

Startseite

Baue die Startseite als TSX-Route app/routes/home.tsx mit ArdoHero und ArdoFeatures. Eine Markdown-Seite kann den Hero nicht rendern; Frontmatter hat deshalb keine Hero- oder Feature-Felder. Komponenten zeigt beide mit ihren Props; Erste Schritte enthält eine vollständige Startseitenroute.