Granularidad

granularity es la única opción que lee el tipo. Toma split — lo predeterminado — o flat, y la diferencia llega más lejos que el número de páginas.

{
  type: 'changelog',
  path: 'CHANGELOG.md',
  label: 'Changelog',
  options: { granularity: 'flat' }
}

#split — una página por versión

Lo predeterminado, y para lo que sirve un historial de versiones. Cada versión pasa a ser una página propia bajo una vista general generada, lo que compra cuatro cosas que una sola página no puede tener:

• un enlace directo a una versión, y a un grupo dentro de ella;
• un resultado de búsqueda que es la versión, y no el fichero entero;
• una entrada de feed por versión, en cuanto feed.path nombre la sección;
• una entrada de llms.txt por versión, de modo que un modelo que pregunte qué cambió en 2.1.0 reciba esa versión y no cuatrocientos kilobytes de historial.

La vista general es una línea de tiempo — cada versión, la más reciente primero, con su fecha y los tipos de cambio al lado, filtrable por esos tipos. Las entradas en sí se quedan en las páginas de versión: repetirlas en la vista general metería el registro entero dos veces en el índice de búsqueda, en llms-full.txt y en el feed.

Las páginas separadas renderizan en un diseño propio: las versiones en la barra lateral, una columna de lectura limitada a una medida, y una columna de contenidos que lista los grupos. Ver Componentes.

#flat — el fichero tal cual

Una página, que contiene el fichero tal como se escribió. Para un proyecto que solo quiere su registro de cambios mostrado.

Un registro plano es una página de documentación corriente y conserva el marco de la documentación — la barra lateral de prosa, la miga de pan y una tabla de contenidos que lista las versiones, que es exactamente lo que quiere un fichero largo. Por eso la pregunta del diseño se responde desde las opciones de la propia declaración en vez de fijarla el tipo: el mismo tipo produce dos cosas distintas.

No se reescribe nada salvo el título. El # Changelog propio del fichero se va, porque la página saca su encabezado de title y un segundo <h1> en el cuerpo es a la vez un duplicado y un hallazgo de accesibilidad. Cada encabezado de versión se queda exactamente donde lo puso la herramienta de releases — que es lo que tiene que significar «sin cambios», o el modo no es la salida de emergencia para la que existe.

#A cuál recurrir