Anulaciones de temas Publii

Antes de entrar en el tema "¿Cómo?" y "¿Por qué?", ​​deberíamos familiarizarnos con los conceptos básicos sobre la estructura de temas de Publii, ya que esto nos ayudará a ver más claramente los beneficios de las modificaciones. Si has revisado un poco los archivos de tu sitio web de Publii (es mucho más fácil hacerlo con las opciones de ubicación de archivos del sitio web que se agregaron en la versión Beta 3 de Publii ), es posible que hayas visto que hay varios tipos de archivos que se incluyen en la creación de un tema:

  • Archivos .hbs : para que los temas de nuestra aplicación sean más fáciles de entender, se crean con Handlebars, que funciona junto con HTML para crear la estructura de un tema. Esto hace que el código del tema sea más comprensible para los principiantes sin sacrificar la flexibilidad para las personas con un poco más de experiencia.
  • Archivos .css : Handlebars nos brinda la estructura, pero es CSS el que nos brinda el estilo. El código CSS se utiliza para establecer la posición de los elementos, darles color, forma y estilo; todo lo que le da carácter a un tema.
  • Archivos .js : Javascript es la columna vertebral de las funciones más complejas que encontrará en la web moderna; si está interactuando con un sitio web más allá de completar formularios y hacer clic en enlaces, entonces Javascript probablemente esté detrás de ello.
  • Archivos .json : los archivos JSON son, básicamente, archivos de texto que se utilizan para almacenar datos; se utilizan en los temas de Publii para almacenar configuraciones, traducciones de temas y similares.

Es posible que te encuentres con algunos tipos de archivos más, pero los que se mencionaron anteriormente son, con diferencia, los más comunes y esenciales. Ahora que sabemos qué tipo de archivos hay en los temas, podemos echar un vistazo a lo que pueden hacer las modificaciones.

¿Qué son las anulaciones de archivos de tema?

Como vimos en la última sección, cada parte de un tema determinado está controlada por un tipo de archivo en particular; entonces, ¿qué sucede si queremos realizar cambios en el estilo base o agregar algunos elementos nuevos a la estructura? La respuesta lógica aquí es que puedes usar los archivos existentes; ¿necesitas cambiar el estilo? Abre el archivo CSS correcto y agrega los cambios. Este método funcionará, pero no pasará mucho tiempo hasta que te topes con algunos problemas.

El mayor problema son las actualizaciones. Digamos que agregas tu propio código a uno de los archivos de tema. Una vez que se lanza una actualización de ese tema, hay una buena posibilidad de que el archivo modificado sea reemplazado durante el proceso de actualización, lo que lo revierte al valor predeterminado y elimina cualquier cambio que hayas agregado antes. Luego está el problema del seguimiento de los cambios. Con tantos archivos que componen un tema, puede ser fácil olvidar exactamente qué archivo se ha modificado con nuestro propio código. Este problema se agrava aún más si varias personas trabajan en el proyecto de forma independiente.

Las anulaciones brindan una solución a ambos problemas, ya que permiten a los usuarios de Publii crear archivos de anulación, que son esencialmente copias de los archivos de tema existentes que se almacenan por separado y que "anularán" o reemplazarán el archivo original. En pocas palabras, cuando Publii crea el diseño de la página utilizando los archivos de tema, verificará si hay archivos en la ubicación de anulación y reemplazará los archivos de tema existentes con estas anulaciones.

Al crear una ubicación separada para los archivos de modificación, es posible realizar un seguimiento exacto de los archivos que se han modificado y mantener una ubicación central que no cambie para insertar su propio código en un tema. Y como Publii ignora las carpetas de modificación excepto cuando se crea el sitio web, podrá mantener una copia de seguridad de sus modificaciones incluso durante las actualizaciones de la aplicación. De esta manera, puede aplicar su propio código a un tema sin el riesgo de perder los cambios en las actualizaciones o tener problemas para realizar un seguimiento de los archivos que se han modificado.

Cómo utilizar archivos de anulación

Crear archivos de anulación es muy sencillo; solo siga estos pasos:

  1. Localice el directorio de temas de su sitio web; este estará en la ruta especificada en la opción Ubicación del sitio en su Configuración global de Publii ; por defecto será C:\Users\yourUserName\Documents\Publii\sites .
  2. Dentro de este directorio verás carpetas para cada uno de tus sitios web de Publii; cada sitio web puede tener sus propias modificaciones, así que abre la carpeta del sitio que deseas cambiar. Verás tres carpetas: input , output y preview ; la carpeta themes estará en la carpeta input , así que ábrela y, por último, abre la carpeta themes ; esta contiene los temas actualmente instalados para el sitio web elegido.
  3. Ahora necesitamos encontrar la carpeta que contiene el tema para el que queremos crear una anulación y anotar el nombre de la carpeta del tema. Luego, necesitaremos crear una nueva carpeta en el directorio de temas, pero nómbrala themeName-override ; por ejemplo, si quisieras modificar el tema Simple, que está en una carpeta llamada simple , entonces crearías una carpeta llamada simple-override en el directorio de temas de tu carpeta de entrada, por ejemplo  Documents\Publii\sites\your-siteName\input\themes
    - simple-override
      |- index.hbs
  4. ¡Ahora estás listo para comenzar a sobrescribir archivos! Puedes sobrescribir prácticamente cualquier archivo del tema simplemente creando una copia en tu nuevo directorio de sobreescritura; copia y pega el archivo desde la ubicación del tema original en la carpeta de sobreescritura; si el archivo original estaba en una subcarpeta de los archivos del tema, entonces la copia de sobreescritura también debería colocarse en una carpeta con el mismo nombre. Por ejemplo, si quisiéramos sobrescribir el archivo main.css , que está en la carpeta themeName\assets\css , entonces necesitaríamos crear una carpeta assets en nuestro directorio themeName-override , luego crear un directorio css dentro de ese y, finalmente, crear una copia del archivo main.css en la carpeta css .
  5. Una vez hecho esto, Publii utilizará el archivo copiado en el directorio de reemplazo para crear el sitio web en lugar del archivo original, por lo que puede comenzar a agregar su propio código al archivo según sea necesario. Recuerde que solo debe agregar los archivos que desea reemplazar en la carpeta de reemplazo; si no se encuentra un archivo en particular en la carpeta de reemplazo, se utilizará automáticamente el archivo original.

Puntos importantes para recordar

Anular archivos es un proceso muy sencillo como vimos en la sección anterior, pero hay algunas cosas importantes a tener en cuenta al utilizar esta función:

  • Si desea anular el archivo language.json , es recomendable utilizar el directorio de idiomas , ya que esto fusionará el archivo de anulación con el archivo original; puede encontrar detalles sobre cómo hacer esto en nuestra Guía de traducción de temas de Publii .
  • Si desea crear un archivo .hbs vacío en el directorio, asegúrese de que contenga al menos un espacio en blanco; si el archivo se deja completamente vacío, recibirá un error al intentar crear su sitio web.
  • La versión anulada de su tema no aparecerá en la lista de temas en la configuración básica, solo será visible la versión original del tema.
  • El nombre del tema reemplazado no se puede cambiar respecto al original, pero puedes modificar las opciones de configuración.
  • Es posible agregar ayudantes adicionales a través del archivo helpers.js si es necesario; esto incluye ayudantes que no estaban en la versión original del tema.
  • Actualmente, el archivo miniatura.png del tema no se puede anular, ya que solo se usa en la pantalla de configuración de la aplicación, donde solo son visibles los archivos del directorio del tema original.
  • Si desea insertar archivos adicionales al tema, colóquelos en el directorio de activos .

Con eso en mente, ya estás listo para comenzar; ¡diviértete agregando tus propios toques personales a los temas que encuentres en Publii, y si tienes alguna pregunta sobre la guía anterior, no dudes en contactarnos en los comentarios a continuación!

arriba