Hugo vs Jekyll: une bataille épique de thèmes de générateur de sites statiques

Dans cet article, nous comparerons les nuances de création de thèmes pour les deux principaux générateurs de sites statiques.

J'ai récemment pris la tâche de créer un thème de site de documentation pour deux projets. Les deux projets avaient besoin des mêmes fonctionnalités de base, mais l'un utilise Jekyll tandis que l'autre utilise Hugo.

Dans la rationalité typique des développeurs, il n'y avait clairement qu'une seule option. J'ai décidé de créer le même thème dans les deux cadres, et de vous donner, cher lecteur, une comparaison côte à côte.

Cet article n'est pas un guide complet de création de thème, mais est plutôt destiné à vous familiariser avec le processus de création d'un thème dans l'un ou l'autre générateur. Voici ce que nous allons couvrir:

  • Organisation des fichiers de thème
  • Où mettre le contenu
  • Comment fonctionne la création de modèles
  • Créer un menu de niveau supérieur avec l' pagesobjet
  • Création d'un menu avec des liens imbriqués à partir d'une liste de données
  • Assembler le modèle
  • Créer des styles
  • Comment configurer et déployer sur des pages GitHub

Voici un wireframe merdique du thème que je vais créer.

Si vous prévoyez de construire en même temps, il peut être utile de servir le thème localement pendant que vous le construisez - et les deux générateurs offrent cette fonctionnalité. Pour Jekyll, courir jekyll serve, et Hugo, hugo serve.

Il y a deux éléments principaux: la zone de contenu principale et le menu de la barre latérale très important. Pour les créer, vous aurez besoin de fichiers de modèle qui indiquent au générateur de site comment générer la page HTML. Pour organiser les fichiers de modèle de thème de manière judicieuse, vous devez d'abord connaître la structure de répertoires attendue par le générateur de site.

Organisation des fichiers de thème

Jekyll prend en charge les thèmes basés sur des gemmes, que les utilisateurs peuvent installer comme n'importe quelle autre gemme Ruby. Cette méthode masque les fichiers de thème dans la gemme, donc pour les besoins de cette comparaison, nous n'utilisons pas de thèmes basés sur des gemmes.

Lorsque vous exécutez jekyll new-theme , Jekyll créera un nouveau thème pour vous. Voici à quoi ressemblent ces fichiers:

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

Les noms de répertoire sont correctement descriptifs. Le _includesrépertoire est destiné à de petits morceaux de code que vous réutilisez à différents endroits, de la même manière que vous mettriez du beurre sur tout. (Juste moi?)

Le _layoutsrépertoire contient des modèles pour différents types de pages de votre site. Le _sassdossier est destiné aux fichiers Sass utilisés pour créer la feuille de style de votre site.

Vous pouvez créer un nouveau thème Hugo en exécutant hugo new theme . Il contient ces fichiers:

. ├── 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 

Vous pouvez voir quelques similitudes. Les fichiers de modèle de page d'Hugo sont intégrés layouts/. Notez que le _defaulttype de page contient des fichiers pour a list.htmlet a single.html.

Contrairement à Jekyll, Hugo utilise ces noms de fichiers spécifiques pour faire la distinction entre les pages de liste (comme une page avec des liens vers tous vos articles de blog) et les pages uniques (comme l'un de vos articles de blog). Le layouts/partials/répertoire contient les bits réutilisables et les fichiers de feuille de style ont un emplacement sélectionné static/css/.

Ces structures de répertoires ne sont pas gravées dans le marbre, car les deux générateurs de sites permettent une certaine personnalisation. Par exemple, Jekyll vous permet de définir des collections et Hugo utilise des ensembles de pages. Ces fonctionnalités vous permettent d'organiser votre contenu de plusieurs manières, mais pour l'instant, voyons où placer des pages simples.

Où mettre le contenu

Pour créer un menu de site qui ressemble à ceci:

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

Vous aurez besoin de deux sections («Introduction» et «Utilisation avancée») contenant leurs sous-sections respectives.

Jekyll n'est pas strict avec son emplacement de contenu. Il attend des pages à la racine de votre site et construira tout ce qui s'y trouve. Voici comment organiser ces pages dans la racine de votre site 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 

Vous pouvez modifier l'emplacement de la source du site dans votre configuration Jekyll.

Dans Hugo, tout le contenu rendu est attendu dans le content/dossier. Cela empêche Hugo d'essayer de rendre les pages que vous ne voulez pas, comme le 404.htmlcontenu du site. Voici comment organiser votre content/répertoire dans Hugo:

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

Pour Hugo, _index.mdet index.mdsignifient des choses différentes. Il peut être utile de savoir quel type de groupe de pages vous voulez pour chaque section: Leaf, qui n'a pas d'enfants, ou Branch.

Maintenant que vous avez une idée de l'endroit où placer les éléments, voyons comment créer un modèle de page.

Comment fonctionne la création de modèles

Les modèles de page Jekyll sont construits avec le langage de création de modèles Liquid. Il utilise des accolades pour le contenu variable de sortie à une page, comme le titre de la page: {{ page.title }}.

Les modèles d'Hugo utilisent également des accolades, mais ils sont construits avec les modèles Go. La syntaxe est similaire, mais différente: {{ .Title }}.

Les modèles Liquid et Go peuvent gérer la logique. Liquid utilise la syntaxe des balises pour désigner les opérations logiques:

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

Et Go Templates place ses fonctions et arguments dans sa syntaxe d'accolades:

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

Les langages de création de modèles vous permettent de créer une page HTML squelette, puis d'indiquer au générateur de site de placer le contenu variable dans les zones que vous définissez. Comparons deux defaultmodèles de page possibles pour Jekyll et 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.