Declarar la sección

Un historial de versiones es una sección generada: una fuente nombra el fichero y el tipo que lo lee, y las páginas se siguen de ahí.

export default defineAppConfig({
  duxt: {
    sources: [
      {
        path: 'docs',
        generated: [
          {
            type: 'changelog',
            path: 'CHANGELOG.md',
            label: 'Releases'
          }
        ]
      }
    ]
  }
})

Los campos que toma una declaración son los mismos para cualquier tipo y están en Fuentes. changelog nombra una opción propia — granularity — y responde las dos políticas de debajo.

#Versionado

Global. Un historial, leído de la versión por defecto, servido en una URL neutral respecto a la versión y con el conmutador suprimido.

Un registro de cambios no es un documento por versión que menciona otras versiones — es la lista de las versiones. Construir una copia por versión publicaría el mismo fichero bajo tres URL, a cada una le faltarían las versiones que vinieron después, y a un lector que cayera en v1 se le diría que el proyecto se paró ahí.

#Localización

El original, en todos los idiomas. Una colección, construida desde el idioma por defecto.

Un registro de versiones se escribe una vez, por la herramienta de releases, en el idioma en el que el proyecto hace commits. No hay nada por idioma en él, así que un sitio localizado sirve el original y lo dice con el aviso de traducción que ya dibuja para una página sin traducir. El mapa locales de la declaración solo lo leen los tipos per-locale y aquí no hace nada.

#Dónde va la entrada

navigation: 'sections' es lo predeterminado y pone la entrada en la fila de secciones — las partes de primer nivel de la documentación.

Un registro de versiones a menudo no es una de ellas: es algo que el proyecto tiene al lado de su documentación, no una parte de ella. navigation: 'navigation' mueve la entrada a la primera fila, estrecha, y false no la pone en ninguna parte y deja que el sitio la enlace.

{
  type: 'changelog',
  path: 'CHANGELOG.md',
  label: 'Releases',
  navigation: 'navigation'
}

#El feed

duxt.feed.path nombra la sección desde la que se construye /rss.xml, y un historial de versiones es para lo que se escribió: cada página de versión lleva el date propio de esa versión, y una versión es algo que ocurrió — cosa que una página de referencia editada no es.

feed: { path: '/releases', title: 'mi proyecto — versiones' }

Apagado mientras la clave no esté puesta. Solo contribuye la versión por defecto de cada fuente, así que un sitio versionado no repite cada entrada una vez por versión — y con una sección global de todos modos solo hay un historial del que tirar. Ver Configuración y /rss.xml.

#Cuando el fichero no se puede leer

Un fichero local que no está hace fallar la compilación mientras se carga la configuración, como con cualquier tipo. Lo que el fichero no acaba de decir — un encabezado que parece una versión pero no se lee como tal — es en cambio una advertencia en el informe de compilación; ver Qué se lee y Qué comprueba la compilación.