Frontmatter
Los campos que una página puede llevar más allá del título y la descripción, y los dos que rellena la compilación.
Content solo almacena lo que declara el esquema de una colección, así que esta es la lista completa: un campo no declarado se descarta en silencio, antes de que la barra lateral o la búsqueda lleguen a verlo.
Lo que escribes tú
| Campo | Tipo | Qué hace |
|---|---|---|
title | string | Se representa como el <h1> de la página, y su título SEO y social |
description | string | El resumen — barra lateral, tarjetas, imagen OG, llms.txt |
icon | string | Se muestra junto a la entrada en la barra lateral, la fila y las fichas |
navigation | boolean | false oculta la página de la navegación |
layout | string | landing representa la página sin el diseño de documentación |
redirectFrom | string[] | URL antiguas de esta página — véase Mover una página |
date | string | Cuándo está fechada esta página, para el feed |
title y description son los dos por cuya ausencia avisa la compilación.
Ninguno rompe una página, y ambos degradan en silencio la tabla de contenidos,
la tarjeta social y llms.txt.
title se representa como el encabezado. Un encabezado # al principio del
archivo es el segundo <h1> de la página.
Lo que rellena la compilación
| Campo | Rellenado por | Contiene |
|---|---|---|
lastUpdated | el módulo git-meta | El último commit que tocó el archivo |
contributors | el módulo git-meta | Nombre, número de commits y usuario, por autor |
rawbody | el esquema de la colección | El Markdown tal como se escribió |
sitemap | la integración de sitemap | Lo que mete la página en /sitemap.xml |
Escribir cualquiera de ellos a mano no sirve de nada: la compilación los
sobrescribe. Los dos campos de git necesitan un historial real, así que una
fuente remota necesita history: true — véase la
referencia de fuentes.
El nombre del archivo lleva dos cosas más
- Un prefijo numérico ordena el árbol y se elimina de la URL:
3.guides/2.deploy.mdse sirve en/guides/deploy. Reordenar nunca mueve una URL. .draft.mdes un borrador. Se sirve en el servidor de desarrollo y no está en la compilación. No haydraft: true, porque el contenido de una colección se declara antes de haber leído archivo alguno — véase Colecciones.