El formato de un proyecto

Este documento es el contrato del formato de un proyecto de Ehundu: cómo se organiza, qué campos admite y qué significa cada cosa. Ehundu lo implementa, una herramienta de edición puede escribirlo y cualquiera puede escribir y compilar un proyecto con un editor de texto y la línea de comandos.

Estado: borrador. Las decisiones cerradas están en el apéndice A (§14).

El contrato se divide en estas secciones:

• 1. Estructura del proyecto: Las carpetas y los ficheros de un proyecto, y lo que escribe el motor.
• 2. sitio.yml: La configuración del sitio: nombre, dirección, idiomas, despliegue y el resto de claves.
• 3. Datos: Los ficheros de datos y lo que heredan las páginas de cada carpeta.
• 4. Ficheros de contenido: Las páginas, sus campos reservados y los tipos de valor.
• 5. URL: Cómo se decide la dirección de cada página, y los patrones.
• 6. Colecciones: Las colecciones y sus filtros, una página por cada valor y las listas partidas en páginas.
• 7. Plantillas: Twig: layouts, parciales, variables, funciones y filtros.
• 8. Markdown: El Markdown, las figuras, los enlaces externos, los encabezados y los atajos.
• 9. Ficheros, CSS y JavaScript: Lo que se copia tal cual, y el CSS y el JavaScript de cada página.
• 10. Salida: Lo que sale a salida/: el sitemap, el feed, los PDF y la compilación por lotes e incremental.
• 11. esquema.json: lo que declara el esquema de un proyecto, que se describe aparte.
• 12. Reglas que no se rompen: Las reglas del formato que no cambian dentro de una versión mayor.
• 13. Lo que Ehundu no hace (todavía): Lo que Ehundu no hace todavía, y por qué no cambia el resto.
• 14. Decisiones: dónde está el registro de decisiones.
• 15. Multiidioma: Un fichero por idioma: direcciones, traducciones, datos, plantillas y fechas.
• Apéndice A. Registro de decisiones: Cada decisión del formato, con su motivo, en el orden en que se tomaron.