Saltar al contenido
duxt

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ú

CampoTipoQué hace
titlestringSe representa como el <h1> de la página, y su título SEO y social
descriptionstringEl resumen — barra lateral, tarjetas, imagen OG, llms.txt
iconstringSe muestra junto a la entrada en la barra lateral, la fila y las fichas
navigationbooleanfalse oculta la página de la navegación
layoutstringlanding representa la página sin el diseño de documentación
redirectFromstring[]URL antiguas de esta página — véase Mover una página
datestringCuá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.

Los controles de la página

Ocho campos más, cada uno de los cuales apaga una pieza de lo que duxt dibuja alrededor de una página. Son la manera en que una página dice para qué sirve: una referencia de API que quiere todo el ancho, una página legal sin «¿Le ha resultado útil esta página?», un esbozo que no debería aparecer en la búsqueda.

CampoTipoPor defectoQué controla
tocfalse | { maxDepth }activada, hasta h3La tabla de contenidos, y hasta dónde llega
breadcrumbbooleanduxt.breadcrumbEl rastro sobre el título
prevNextbooleantrueEl par de anterior y siguiente bajo el artículo
feedbackbooleantrueLa fila de «¿Le ha resultado útil esta página?»
pageInfobooleantrueEnlace de edición, última actualización, colaboradores
copyPagebooleantrueCopiar página, y el menú para entregarla a un modelo
fullWidthbooleanfalsetrue quita el límite de ancho de lectura
searchbooleantruefalse saca la página de la búsqueda
---
title: Condiciones del servicio
feedback: false
prevNext: false
search: false
---

Todos se componen, y ninguno implica a otro. fullWidth: true quita la medida de lectura y nada más — la columna de contenidos y el bloque de procedencia se quedan salvo que también se apaguen — y copyPage: false deja en paz el bloque de procedencia. Una página que no fija ninguno se ve exactamente como siempre.

breadcrumb es el que tiene detrás un interruptor para todo el sitio, duxt.breadcrumb. La página gana allí donde habla, así que un sitio que ocultó el rastro en todas partes puede devolverlo en la única página cuyo rastro es justo lo importante.

Hasta dónde llega la tabla de contenidos

toc: false elimina la columna. La forma de objeto fija el encabezado más profundo que lista, escrito como nivel de encabezado — la lista siempre empieza en h2, y h3 es el valor por defecto.

---
title: Configuración
toc:
  maxDepth: 4
---

maxDepth acepta de 2 a 6. Cualquier otra cosa recae en el valor por defecto en vez de vaciar la columna: no existe h7, y h1 es el título.

Qué hace search: false, y qué no

Saca la página de todas las superficies que duxt ofrece para encontrar algo: el diálogo de búsqueda, su recurso a las coincidencias aproximadas, la herramienta MCP search_docs, y tanto llms.txt como llms-full.txt.

No cambia nada de la dirección de la página. La URL, la canónica, la entrada del sitemap y los metadatos de robots quedan intactos, la página se representa como siempre, y el read_page de MCP sigue respondiendo por ella. La página se vuelve inencontrable, no despublicada. Para mantener una página fuera del árbol de navegación, eso es navigation: false; para mantenerla fuera de un motor de búsqueda, eso es asunto del rastreador y no de este campo.

Lo que rellena la compilación

CampoRellenado porContiene
lastUpdatedel módulo git-metaEl último commit que tocó el archivo
contributorsel módulo git-metaNombre, número de commits y usuario, por autor
rawbodyel esquema de la colecciónEl Markdown tal como se escribió
sitemapla integración de sitemapLo 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.md se sirve en /guides/deploy. Reordenar nunca mueve una URL.
  • .draft.md es un borrador. Se sirve en el servidor de desarrollo y no está en la compilación. No hay draft: true, porque el contenido de una colección se declara antes de haber leído archivo alguno — véase Colecciones.
¿Le ha resultado útil esta página?