Errores Comunes en HUGO
Nombres de carpetas del proyecto
Las carpetas pertenecientes al proyecto Hugo deben estar en minúscula, como se muestra a continuación:
Las carpetas de la imagen anterior se encuentran en minúscula, como home, archetypes, content, resources, entre otros. Por experiencia propia de los desarrolladores del Proyecto Coolibri, se realiza de esta manera para evitar que se generen errores al momento de generar el sitio de Hugo.
Este error, se encuentra directamente relacionado con la sintaxis o configuración de Hugo. Por lo que, se recomienda crear las carpetas con las especificaciones dadas.
Escritura markdown del proyecto
Los archivos markdown pertenecientes al proyecto Hugo se recomienda nombrarlos en minúscula, como se muestra a continuación:
Los archivos markdown (md) en la imagen anterior se encuentran en minúscula, lo que permite evitar errores al momento de generar el sitio de Hugo. Igualmente, se observa que esta el archivo markdown principal con el nombre index y los archivos markdown secundarios con los nombres java, junit, linux y maven. Es importante, realizar la distinción entre el archivo principal y los archivos secundarios, ya que solo el archivo principal se debe llamar index.md para que no genere conflicto con los demás archivos markdown al momento de generar el sitio de Hugo.
Por experiencia propia, en la carpeta de cursos se tenia el archivo principal index.md y los archivos secundarios estaban nombrados como _indexJava.md, _indexJunit.md, _indexLinux.md, _indexMaven.md. De esa manera, al momento de generar el sitio Hugo en el servidor de GitHub, provoca el siguiente error:
Este error, se encuentra directamente relacionado con la sintaxis o configuración de Hugo. Por lo que, se recomienda crear los archivos markdown con las especificaciones dadas.
Configurar config.toml
El archivo config.toml se configura dependiendo del numero de menús verticales que se requieran en la página de Hugo. En la siguiente imagen, se tiene el menú principal y el menú documentación:
La forma de configurar el archivo .toml es la siguiente:
Cada carpeta vertical debe contar con un identificador, un nombre, una URL y un peso. El identificador hace referencia al titulo dado en el _index de la carpeta home, en este caso COOLIBRI y al titulo dado al _index.md de la carpeta documentación. El nombre hace referencia a como aparece en la página de Hugo, en este caso “Principal” y “Documentación”. La URL hace referencia en que dirección o carpeta dentro del proyecto Hugo se encuentra el respectivo archivo _index.md. Finalmente, el peso esta relacionado con la importancia del menú vertical. El menú vertical “Principal” tiene mayor peso que el menú “Documentación”. Por lo que, al momento de desplegar la página, se observara primero aparecerá primero el menú “Principal”.
Siguiendo las indicaciones mencionadas anteriormente, se evita presentar inconvenientes al momento de generar el sitio de Hugo.