Frontmatter
Controla los metadatos, la navegación, el diseño y la salida de compilación desde cada archivo.
En esta página
El frontmatter mantiene las decisiones de cada página junto al contenido: título, descripción, orden lateral, diseño, índice, enlaces de edición y salida de compilación.
Ardo normaliza los campos documentados una sola vez para metadatos, barras laterales, búsqueda, redirecciones, sitemap y exportaciones LLM. La compilación de producción indica los valores no válidos y su archivo. Los campos desconocidos se aceptan por defecto, pero puedes señalarlos o bloquearlos en la configuración.
Uso básico
---
title: My Page Title
description: A description for SEO
---
# Page Content
Your content here...
Opciones disponibles
title
- Tipo:
string
El título de la página. Se usa en la pestaña del navegador y como <h1> si el contenido no lo incluye.
---
title: Getting Started
---
description
- Tipo:
string
La descripción de la página para las etiquetas meta SEO.
---
description: Learn how to get started with Ardo
---
Ardo también muestra description como introducción bajo el título. Si el primer párrafo tiene el mismo texto normalizado, omite la introducción para evitar repetir la frase.
lede
- Tipo:
boolean - Predeterminado:
true
Define lede: false si description solo debe aparecer en los metadatos.
---
title: Getting Started
description: Learn how to get started with Ardo
lede: false
---
Metadatos para redes sociales
Las rutas Markdown sin exportación meta reciben metadatos del navegador, canónicos, Open Graph y Twitter generados a partir del frontmatter y la configuración del sitio.
---
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
---
canonicalsustituye la URL canónica generada yog:url.ogTitle,ogDescription,ogImageyogTypecontrolan Open Graph.twitterTitle,twitterDescription,twitterImageytwitterCardcontrolan las Twitter Cards.siteUrlconvierte en absolutas las URL relativas canónicas y de imágenes. SinsiteUrl, esas etiquetas relativas se omiten.
layout
- Tipo:
"bare" | "default" - Predeterminado:
"default"
bare elimina la barra lateral y el panel derecho, como en una portada; la cabecera muestra la búsqueda como icono. default es el diseño de documentación con barra lateral e índice. La portada / siempre usa bare.
---
layout: bare
---
sidebar
- Tipo:
boolean | "leaf" - Predeterminado:
true
sidebar: false elimina la página de la barra lateral generada. Se sigue compilando y es accesible mediante un enlace.
---
sidebar: false
---
Usa sidebar: leaf en index.md o index.mdx para mostrar el directorio como un único enlace, sin enumerar sus páginas hijas.
order
- Tipo:
number
Controla el orden dentro del mismo directorio. Los elementos con order aparecen antes de los demás, que se ordenan alfabéticamente. Los enlaces anterior y siguiente siguen ese orden.
---
title: Getting Started
order: 1
---
Metadatos del índice de directorio
Si un directorio de rutas contiene index.md o index.mdx, su frontmatter configura el grupo generado por ArdoGeneratedSidebar.
---
title: Guide
order: 10
collapsed: false
---
titledefine el nombre del grupo.orderordena el grupo entre páginas y grupos vecinos. Los directorios de primer nivel son secciones; ordénalas considebar.sectionOrder.collapseddefine el estado contraído inicial. El grupo se abre al visitar una página que contiene.
outline
- Tipo:
boolean - Predeterminado:
true
Define outline: false para ocultar el índice de la página. Los niveles de títulos mostrados se configuran para todo el sitio con markdown.toc.level en ardo.config.ts.
---
outline: false
---
editLink
- Tipo:
boolean - Predeterminado:
true
Indica si se muestra el enlace para editar la página.
---
editLink: false
---
lastUpdated
- Tipo:
boolean - Predeterminado:
true
Indica si se muestra la fecha de la última actualización.
---
lastUpdated: false
---
Opciones de salida de compilación
sitemap
- Tipo:
boolean - Predeterminado:
true
Excluye una ruta Markdown del sitemap generado sin ocultarla de la navegación.
---
title: Internal Migration Notes
sitemap: false
---
llms
- Tipo:
boolean - Predeterminado:
true
Excluye una ruta Markdown de /llms.txt y /llms-full.txt. Es útil para páginas válidas para personas pero ruidosas en un único contexto de modelo, como registros de cambios generados o referencias de pruebas extensas.
---
title: Fixture Catalog
llms: false
---
redirectFrom
- Tipo:
string | string[]
Genera redirecciones estáticas desde rutas antiguas a esta página. Usa una cadena para una ruta o un array para varias ubicaciones.
---
title: Configuration
redirectFrom:
- /config
- /guide/options
---
Ardo combina estas redirecciones con redirects de ardo.config.ts y genera los archivos adecuados para los proveedores en la compilación de producción.
Página de inicio
Crea la portada como ruta TSX, app/routes/home.tsx, con ArdoHero y ArdoFeatures. Una página Markdown no puede mostrar el hero, así que el frontmatter no incluye campos hero o features. Componentes muestra sus props y Primeros pasos incluye una ruta completa.