Frontmatter

Le frontmatter conserve les décisions propres à une page au plus près de son contenu : titre, description, ordre latéral, mise en page, sommaire, liens de modification et sorties de build.

Ardo normalise les champs documentés une seule fois pour les métadonnées, barres latérales, recherche, redirections, sitemap et exports LLM. Le build de production signale les valeurs incorrectes avec leur fichier source. Les champs inconnus restent acceptés par défaut, mais la configuration permet de les signaler ou de les refuser.

Utilisation de base

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

Your content here...

Options disponibles

title

• Type:string

Le titre de la page, utilisé dans l’onglet du navigateur et comme <h1> si le contenu n’en fournit pas.

---
title: Getting Started
---

description

• Type:string

La description de la page pour les balises meta SEO.

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

Ardo affiche aussi description en introduction sous le titre. Si le premier paragraphe contient le même texte normalisé, cette introduction est omise pour éviter de répéter la phrase.

lede

• Type:boolean
• Valeur par défaut :true

Définissez lede: false pour conserver description uniquement dans les métadonnées.

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

Métadonnées sociales

Les routes Markdown sans export meta reçoivent des métadonnées de navigateur, canoniques, Open Graph et Twitter générées depuis le frontmatter et la configuration du site.

---
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 remplace l’URL canonique générée et og:url.
• ogTitle, ogDescription, ogImage et ogType contrôlent Open Graph.
• twitterTitle, twitterDescription, twitterImage et twitterCard contrôlent les Twitter Cards.
• siteUrl rend absolues les URL relatives de canonique et d’image. Sans siteUrl, les balises d’URL relatives sont omises.

layout

• Type:"bare" | "default"
• Valeur par défaut :"default"

bare retire la barre latérale et le rail droit, comme sur une page d’accueil ; la recherche devient une icône dans l’en-tête. default affiche la documentation avec barre latérale et sommaire. L’accueil à / utilise toujours la mise en page bare.

---
layout: bare
---

sidebar

• Type:boolean | "leaf"
• Valeur par défaut :true

sidebar: false retire la page de la barre latérale générée. Elle reste construite et accessible par lien.

---
sidebar: false
---

Utilisez sidebar: leaf dans index.md ou index.mdx pour afficher le répertoire comme un seul lien, sans lister automatiquement ses enfants.

order

• Type:number

Contrôle l’ordre dans un même répertoire. Les entrées avec order précèdent les autres, triées alphabétiquement. Les liens précédent et suivant suivent le même ordre.

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

Métadonnées d’index de répertoire

Lorsqu’un répertoire de routes contient index.md ou index.mdx, son frontmatter configure le groupe généré par ArdoGeneratedSidebar.

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

• title définit le libellé du groupe.
• order trie le groupe parmi les pages et groupes voisins. Les dossiers de premier niveau deviennent des sections ; ordonnez-les avec sidebar.sectionOrder.
• collapsed définit l’état replié initial. Un groupe replié s’ouvre sur les pages qu’il contient.

outline

• Type:boolean
• Valeur par défaut :true

Définissez outline: false pour masquer le sommaire de la page. Les niveaux de titres affichés se règlent pour tout le site avec markdown.toc.level dans ardo.config.ts.

---
outline: false
---

editLink

• Type:boolean
• Valeur par défaut :true

Indique si le lien de modification de la page s’affiche.

---
editLink: false
---

lastUpdated

• Type:boolean
• Valeur par défaut :true

Indique si la date de dernière mise à jour s’affiche.

---
lastUpdated: false
---

Options de sortie du build

sitemap

• Type:boolean
• Valeur par défaut :true

Exclut une route Markdown du sitemap généré sans la masquer de la navigation.

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

llms

• Type:boolean
• Valeur par défaut :true

Exclut une route Markdown de /llms.txt et /llms-full.txt. Utile pour des pages pertinentes pour les lecteurs mais trop volumineuses dans un contexte LLM unique, comme les historiques générés ou de grandes références de tests.

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

redirectFrom

• Type:string | string[]

Génère des redirections statiques depuis les anciens chemins vers cette page. Utilisez une chaîne pour un chemin ou un tableau pour plusieurs adresses.

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

Ardo combine ces redirections avec l’option redirects d’ardo.config.ts et produit les fichiers adaptés aux hébergeurs lors du build de production.

Page d’accueil

Construisez l’accueil comme route TSX, app/routes/home.tsx, avec ArdoHero et ArdoFeatures. Une page Markdown ne peut pas rendre le hero ; le frontmatter n’a donc pas de champs hero ou features. Composants présente leurs props, et Premiers pas fournit une route complète.