Hugo vs Jekyll: una batalla épica de temas de generador de sitios estáticos

En este artículo, compararemos los matices de la creación de temas para los dos principales generadores de sitios estáticos.

Recientemente, asumí la tarea de crear un tema de sitio de documentación para dos proyectos. Ambos proyectos necesitaban las mismas características básicas, pero uno usa Jekyll mientras que el otro usa Hugo.

En la racionalidad típica de los desarrolladores, claramente solo había una opción. Decidí crear el mismo tema en ambos marcos y ofrecerle, querido lector, una comparación lado a lado.

Esta publicación no es una guía completa de creación de temas, sino que está destinada a familiarizarlo con el proceso de creación de un tema en cualquiera de los dos generadores. Esto es lo que cubriremos:

  • Cómo se organizan los archivos de tema
  • Dónde poner contenido
  • Cómo funcionan las plantillas
  • Crear un menú de nivel superior con el pagesobjeto
  • Crear un menú con enlaces anidados a partir de una lista de datos
  • Armar la plantilla
  • Creando estilos
  • Cómo configurar e implementar en páginas de GitHub

Aquí hay una estructura alámbrica de mierda del tema que voy a crear.

Si está planeando construir en conjunto, puede ser útil servir el tema localmente a medida que lo crea, y ambos generadores ofrecen esta funcionalidad. Para Jekyll, ejecutar jekyll serve, y de Hugo, hugo serve.

Hay dos elementos principales: el área de contenido principal y el importante menú de la barra lateral. Para crearlos, necesitará archivos de plantilla que le indiquen al generador del sitio cómo generar la página HTML. Para organizar los archivos de plantilla de tema de una manera sensata, primero debe saber qué estructura de directorio espera el generador de sitios.

Cómo se organizan los archivos de tema

Jekyll admite temas basados ​​en gemas, que los usuarios pueden instalar como cualquier otra gema de Ruby. Este método oculta los archivos de tema en la gema, por lo que para los fines de esta comparación, no estamos utilizando temas basados ​​en gemas.

Cuando corras jekyll new-theme , Jekyll creará un nuevo tema para ti. Así es como se ven esos archivos:

. ├── assets ├── Gemfile ├── _includes ├── _layouts │   ├── default.html │   ├── page.html │   └── post.html ├── LICENSE.txt ├── README.md ├── _sass └── .gemspec 

Los nombres de directorio son apropiadamente descriptivos. El _includesdirectorio es para pequeños fragmentos de código que reutiliza en diferentes lugares, de la misma manera que pondría mantequilla en todo. (¿Solo yo?)

El _layoutsdirectorio contiene plantillas para diferentes tipos de páginas de su sitio. La _sasscarpeta es para los archivos Sass que se utilizan para crear la hoja de estilo de su sitio.

Puede crear un nuevo tema de Hugo ejecutando hugo new theme . Tiene estos archivos:

. ├── archetypes │   └── default.md ├── layouts │   ├── 404.html │   ├── _default │   │   ├── baseof.html │   │   ├── list.html │   │   └── single.html │   ├── index.html │   └── partials │   ├── footer.html │   ├── header.html │   └── head.html ├── LICENSE ├── static │   ├── css │   └── js └── theme.toml 

Puedes ver algunas similitudes. Los archivos de plantilla de página de Hugo están metidos en layouts/. Tenga en cuenta que el _defaulttipo de página tiene archivos para a list.htmly a single.html.

A diferencia de Jekyll, Hugo usa estos nombres de archivo específicos para distinguir entre páginas de lista (como una página con enlaces a todas las publicaciones de su blog) y páginas individuales (como una de las publicaciones de su blog). El layouts/partials/directorio contiene los bits reutilizables mantecosos, y los archivos de hojas de estilo tienen un lugar seleccionado static/css/.

Estas estructuras de directorio no están grabadas en piedra, ya que ambos generadores de sitios permiten cierta medida de personalización. Por ejemplo, Jekyll le permite definir colecciones y Hugo hace uso de paquetes de páginas. Estas funciones le permiten organizar su contenido de varias formas, pero por ahora, veamos dónde colocar algunas páginas simples.

Dónde poner contenido

Para crear un menú de sitio con este aspecto:

Introduction Getting Started Configuration Deploying Advanced Usage All Configuration Settings Customizing Help and Support 

Necesitará dos secciones ("Introducción" y "Uso avanzado") que contienen sus respectivas subsecciones.

Jekyll no es estricto con la ubicación de su contenido. Espera páginas en la raíz de su sitio y construirá lo que esté allí. Así es como puede organizar estas páginas en la raíz de su sitio Jekyll:

. ├── 404.html ├── assets ├── Gemfile ├── _includes ├── index.markdown ├── intro │   ├── config.md │   ├── deploy.md │   ├── index.md │   └── quickstart.md ├── _layouts │   ├── default.html │   ├── page.html │   └── post.html ├── LICENSE.txt ├── README.md ├── _sass ├── .gemspec └── usage ├── customizing.md ├── index.md ├── settings.md └── support.md 

Puede cambiar la ubicación de la fuente del sitio en su configuración de Jekyll.

En Hugo, todo el contenido renderizado se espera en la content/carpeta. Esto evita que Hugo intente representar páginas que no desea, como el 404.htmlcontenido del sitio. Así es como puede organizar su content/directorio en Hugo:

. ├── _index.md ├── intro │ ├── config.md │ ├── deploy.md │ ├── _index.md │ └── quickstart.md └── usage ├── customizing.md ├── _index.md ├── settings.md └── support.md 

Para Hugo, _index.mdy index.mdsignificar cosas diferentes. Puede resultar útil saber qué tipo de paquete de páginas desea para cada sección: Leaf, que no tiene hijos, o Branch.

Ahora que tiene una idea de dónde colocar las cosas, veamos cómo crear una plantilla de página.

Cómo funcionan las plantillas

Las plantillas de página de Jekyll se crean con el lenguaje de plantillas Liquid. Utiliza los apoyos a la producción de contenidos variables de una página, como el título de la página: {{ page.title }}.

Las plantillas de Hugo también usan aparatos ortopédicos, pero están construidas con plantillas Go. La sintaxis es similar, pero diferente: {{ .Title }}.

Tanto Liquid como Go Templates pueden manejar la lógica. Liquid usa la sintaxis de etiquetas para denotar operaciones lógicas:

{% if user %} Hello {{ user.name }}! {% endif %} 

And Go Templates coloca sus funciones y argumentos en su sintaxis de llaves:

{{ if .User }} Hello {{ .User }}! {{ end }} 

Los lenguajes de plantillas le permiten crear una página HTML esqueleto, luego decirle al generador del sitio que coloque contenido variable en las áreas que usted defina. Comparemos dos posibles defaultplantillas de página para Jekyll y Hugo.

Jekyll’s scaffold default theme is bare, so we’ll look at their starter theme Minima. Here’s _layouts/default.html in Jekyll (Liquid):

  {%- include head.html -%}  {%- include header.html -%} {{ content }} {%- include footer.html -%}   

Here’s Hugo’s scaffold theme layouts/_default/baseof.html (Go Templates):

  {{- partial "head.html" . -}}  {{- partial "header.html" . -}} {{- block "main" . }}{{- end }} {{- partial "footer.html" . -}}   

Different syntax, same idea. Both templates pull in reusable bits for head.html, header.html, and footer.html.  These show up on a lot of pages, so it makes sense not to have to  repeat yourself.

Both templates also have a spot for the main content, though the Jekyll template uses a variable ({{ content }}) while Hugo uses a block ({{- block "main" . }}{{- end }}). Blocks are just another way Hugo lets you define reusable bits.

Now that you know how templating works, you can build the sidebar menu for the theme.

Creating a top-level menu with the pages object

You can programmatically create a top-level menu from your pages. It will look like this:

Introduction Advanced Usage 

Let’s start with Jekyll. You can display links to site pages in your Liquid template by iterating through the site.pages object that Jekyll provides and building a list:


    
    {% for page in site.pages %}
  • {{ page.title }}
  • {% endfor %}

This returns all of the site’s pages, including all the ones that you might not want, like 404.html. You can filter for the pages you actually want with a couple more tags, such as conditionally including pages if they have a section: true parameter set:


    
    {% for page in site.pages %} {%- if page.section -%}
  • {{ page.title }}
  • {%- endif -%} {% endfor %}

You can achieve the same effect with slightly less code in Hugo. Loop through Hugo’s .Pages object using Go Template’s range action:


    
    {{ range .Pages }}
  • {{.Title}}
  • {{ end }}

This template uses the .Pages object to return all the top-level pages in content/ of your Hugo site. Since Hugo uses a specific folder for the site content you want rendered, there’s no additional filtering necessary to build a simple menu of site pages.

Creating a menu with nested links from a data list

Both site generators can use a separately defined data list of links to render a menu in your template. This is more suitable for creating nested links, like this:

Introduction Getting Started Configuration Deploying Advanced Usage All Configuration Settings Customizing Help and Support 

Jekyll supports data files in a few formats, including YAML. Here’s the definition for the menu above in _data/menu.yml:

section: - page: Introduction url: /intro subsection: - page: Getting Started url: /intro/quickstart - page: Configuration url: /intro/config - page: Deploying url: /intro/deploy - page: Advanced Usage url: /usage subsection: - page: Customizing url: /usage/customizing - page: All Configuration Settings url: /usage/settings - page: Help and Support url: /usage/support 

Here’s how to render the data in the sidebar template:

{% for a in site.data.menu.section %} {{ a.page }} 
    
    {% for b in a.subsection %}
  • {{ b.page }}
  • {% endfor %}
{% endfor %}

This method allows you to build a custom menu, two nesting levels deep. The nesting levels are limited by the for loops in the template. For a recursive version that handles further levels of nesting, see Nested tree navigation with recursion.

Hugo does something similar with its menu templates. You can define menu links in your Hugo site config, and even add useful properties that Hugo understands, like weighting. Here’s a definition of the menu above in config.yaml:

sectionPagesMenu: main menu: main: - identifier: intro name: Introduction url: /intro/ weight: 1 - name: Getting Started parent: intro url: /intro/quickstart/ weight: 1 - name: Configuration parent: intro url: /intro/config/ weight: 2 - name: Deploying parent: intro url: /intro/deploy/ weight: 3 - identifier: usage name: Advanced Usage url: /usage/ - name: Customizing parent: usage url: /usage/customizing/ weight: 2 - name: All Configuration Settings parent: usage url: /usage/settings/ weight: 1 - name: Help and Support parent: usage url: /usage/support/ weight: 3 

Hugo uses the identifier, which must match the section name, along with the parent variable to handle nesting. Here’s how to render the menu in the sidebar template:


    
    {{ range .Site.Menus.main }} {{ if .HasChildren }}
  • {{ .Name }}
    • {{ range .Children }}
    • {{ .Name }}
    • {{ end }}
    {{ else }}
  • {{ .Name }}
  • {{ end }} {{ end }}

The range function iterates over the menu data, and Hugo’s .Children variable handles nested pages for you.

Putting the template together

With your menu in your reusable sidebar bit (_includes/sidebar.html for Jekyll and partials/sidebar.html for Hugo), you can add it to the default.html template.

In Jekyll:

  {%- include head.html -%}  {%- include sidebar.html -%} {%- include header.html -%} {{ content }} {%- include footer.html -%}   

In Hugo:

  {{- partial "head.html" . -}}  {{- partial "sidebar.html" . -}} {{- partial "header.html" . -}} {{- block "main" . }}{{- end }} {{- partial "footer.html" . -}}   

When the site is generated, each page will contain all the code from your sidebar.html.

Create a stylesheet

Both site generators accept Sass for creating CSS stylesheets. Jekyll has Sass processing built in, and Hugo uses Hugo Pipes. Both options have some quirks.

Sass and CSS in Jekyll

To process a Sass file in Jekyll, create your style definitions in the _sass directory. For example, in a file at _sass/style-definitions.scss:

$background-color: #eef !default; $text-color: #111 !default; body { background-color: $background-color; color: $text-color; } 

Jekyll won’t generate this file directly, as it only processes files with front matter. To create the end-result  filepath for your site’s stylesheet, use a placeholder with empty front matter where you want the .css file to appear. For example, assets/css/style.scss. In this file, simply import your styles:

--- --- @import "style-definitions"; 

This rather hackish configuration has an upside: you can use Liquid template tags and variables in your placeholder file. This is a nice way to allow users to set variables from the site _config.yml, for example.

The resulting CSS stylesheet in your generated site has the path /assets/css/style.css. You can link to it in your site’s head.html using:

Sass and Hugo Pipes in Hugo

Hugo uses Hugo Pipes to process Sass to CSS. You can achieve this by using Hugo’s asset processing function, resources.ToCSS, which expects a source in the assets/ directory. It takes the SCSS file as an argument.

With your style definitions in a Sass file at assets/sass/style.scss, here’s how to get, process, and link your Sass in your theme’s head.html:

{ $style := resources.Get "/sass/style.scss" }  

Hugo asset processing requires extended Hugo, which you may not have by default. You can get extended Hugo from the releases page.

Configure and deploy to GitHub Pages

Before your site generator can build your site, it needs a  configuration file to set some necessary parameters. Configuration files  live in the site root directory. Among other settings, you can declare  the name of the theme to use when building the site.

Configure Jekyll

Here’s a minimal _config.yml for Jekyll:

title: Your awesome title description: >- # this means to ignore newlines until "baseurl:" Write an awesome description for your new site here. You can edit this line in _config.yml. It will appear in your document head meta (for Google search results) and in your feed.xml site description. baseurl: "" # the subpath of your site, e.g. /blog url: "" # the base hostname & protocol for your site, e.g. //example.com theme: # for gem-based themes remote_theme: # for themes hosted on GitHub, when used with GitHub Pages 

With remote_theme, any Jekyll theme hosted on GitHub can be used with sites hosted on GitHub Pages.

Jekyll has a default configuration, so any parameters added to your configuration file will override the defaults. Here are additional configuration settings.

Configure Hugo

Here’s a minimal example of Hugo’s config.yml:

baseURL: //example.com/ # The full domain your site will live at languageCode: en-us title: Hugo Docs Site theme: # theme name 

Hugo makes no assumptions, so if a necessary parameter is missing, you’ll see a warning when building or serving your site. Here are all configuration settings for Hugo.

Deploy to GitHub Pages

Both generators build your site with a command.

For Jekyll, use jekyll build. See further build options here.

For Hugo, use hugo. You can run hugo help or see further build options here.

You’ll have to choose the source for your GitHub Pages site. Once done, your site will update each time you push a new build. Of course, you can also automate your GitHub Pages build using GitHub Actions. Here’s one for building and deploying with Hugo, and one for building and deploying Jekyll.

Showtime!

All the substantial differences between these two generators are under the hood. All the same, let’s take a look at the finished themes, in two color variations.

Here’s Hugo:

Here's Jekyll:

Wait who won?

?

Both Hugo and Jekyll have their quirks and conveniences.

From this developer’s perspective, Jekyll is a workable choice for simple sites without complicated organizational needs. If you’re looking to render some one-page posts in an available theme and host with GitHub Pages, Jekyll will get you up and running fairly quickly.

Personally, I use Hugo. I like the organizational capabilities of its Page Bundles, and it’s backed by a dedicated and conscientious team that really seems to strive to facilitate convenience for their users. This is evident in Hugo’s many functions, and handy tricks like Image Processing and Shortcodes. They seem to release new fixes and versions about as often as I make a new cup of coffee - which, depending on your use case, may be fantastic, or annoying.

If you still can’t decide, don’t worry. The OpenGitDocs documentation theme I created is available for both Hugo and Jekyll. Start with one, switch later if you want. That’s the benefit of having options.