Puedes añadir varias piezas de metadatos a un tema. Algunas se almacenan en el archivo about.json y otras en los archivos de localización.
about.json
información del formato de archivo
name (cadena, requerido): El nombre predeterminado para el tema cuando se instala. Los administradores pueden cambiar esto después de que el tema se haya instalado.
component (booleano, predeterminado false): si el tema debe tratarse como un componente.
license_url (cadena, opcional): una URL para un archivo de licencia. Se mostrará un enlace a esto en la interfaz de administración. La mayoría de los temas lo utilizan para enlazar a su archivo de licencia en GitHub.
about_url (cadena, opcional): una URL que contiene más información sobre el tema. Se mostrará un enlace a esto en la interfaz de administración. La mayoría de los temas lo utilizan para enlazar a su tema en Meta.
authors (cadena, opcional): una cadena para describir al autor del tema. Se muestra en la interfaz de administración.
theme_version (cadena, opcional): una cadena arbitraria para describir la versión del tema. Se muestra en la interfaz de administración.
screenshots (array, opcional): Hasta dos rutas de captura de pantalla que se utilizarán en varios lugares de la interfaz de usuario para mostrar capturas de pantalla del tema. Consulta a continuación para obtener más detalles sobre las restricciones.
minimum_discourse_version (cadena, opcional): la versión más temprana de discourse con la que este tema es compatible. Si no coincide, el tema se deshabilitará automáticamente. Debe tener el formato 2.4.0.beta1.
maximum_discourse_version (cadena, opcional): la versión más reciente de discourse con la que este tema es compatible. Si no coincide, el tema se deshabilitará automáticamente. Debe tener el formato 2.4.0.beta1.
archivos de localización (ej. en.yml)
información del formato de archivo
theme_metadata.description: Una descripción localizada del tema. Se muestra en la interfaz de administración.
theme_metadata.settings.setting_name: Una descripción localizada de setting_name, que se muestra debajo de la configuración del tema en el panel de administración.
Capturas de pantalla
Los temas y componentes pueden definir un máximo de dos capturas de pantalla en la clave screenshots de about.json, que se verá algo así:
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
Ten en cuenta estas restricciones:
- Las capturas de pantalla deben estar en una carpeta
screenshotsen el repositorio de GitHub del tema - Tamaño máximo de archivo:
1 MB - Resolución máxima:
3840×2160(4K) - Relación de aspecto recomendada:
16:9 - Formatos permitidos:
.webp,.png,.jpeg,.jpg
También seguimos una convención para incluir capturas de pantalla tanto light (claro) como dark (oscuro).
Este documento está controlado por versiones: sugiere cambios en github.