Hugo vs Jekyll: Epic Battle of Static Site Generator Themes

У цій статті ми порівняємо нюанси створення тем для двох найкращих генераторів статичних сайтів.

Нещодавно я взявся за завдання створити тему сайту документації для двох проектів. Обидва проекти потребували однакових основних функцій, але один використовує Jekyll, тоді як інший використовує Hugo.

У типовій раціональності розробника явно був лише один варіант. Я вирішив створити одну і ту ж тему в обох рамках і дати вам, шановний читачу, паралельне порівняння.

Ця публікація не є вичерпним керівництвом з побудови теми, а має на меті ознайомити вас із процесом побудови теми в будь-якому генераторі. Ось що ми розглянемо:

  • Як організовані файли тем
  • Куди покласти вміст
  • Як працює шаблонування
  • Створення меню верхнього рівня з pagesоб’єктом
  • Створення меню із вкладеними посиланнями зі списку даних
  • Складання шаблону
  • Створення стилів
  • Як налаштувати та розгорнути сторінки GitHub

Ось безглуздий каркас теми, яку я збираюся створити.

Якщо ви плануєте вдосконалення, може бути корисно подавати тему локально під час її побудови - і обидва генератори пропонують цю функцію. Для Джекіла - бігай, jekyll serveа для Гюго - hugo serve.

Є два основні елементи: основна область вмісту та головне меню бічної панелі. Для їх створення вам знадобляться файли шаблонів, які повідомляють генератору сайтів, як створити HTML-сторінку. Щоб розумно впорядкувати файли шаблонів тем, спочатку потрібно знати, яку структуру каталогів очікує генератор сайтів.

Як організовані файли тем

Jekyll підтримує теми на основі дорогоцінних каменів, які користувачі можуть встановити, як і будь-які інші дорогоцінні камені Ruby. Цей метод приховує файли тем у самоцвіті, тому для цілей цього порівняння ми не використовуємо теми на основі самоцвітів.

Коли ти побіжиш jekyll new-theme , Джекілл створить для тебе нову тему. Ось як виглядають ці файли:

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

Назви каталогів мають відповідний опис. _includesКаталог для невеликих фрагментів коду , які ви повторно використовувати в різних місцях, в основному так само , як ви б покласти масло на все. (Тільки я?)

_layoutsКаталог містить шаблони для різних типів сторінок на вашому сайті. _sassПапка для Sass файлів , використовуваних для створення таблиці стилів вашого сайту.

Ви можете запустити нову тему Hugo, запустивши hugo new theme . У ньому є такі файли:

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

Ви можете побачити деякі подібності. Файли шаблонів сторінок Hugo завантажені layouts/. Зверніть увагу, що _defaultтип сторінки має файли для a list.htmlта a single.html.

На відміну від Jekyll, Hugo використовує ці конкретні імена файлів, щоб розрізнити сторінки списку (наприклад, сторінку з посиланнями на всі ваші публікації в блозі) та окремі сторінки (наприклад, одну з публікацій вашого блогу). layouts/partials/Каталог містить маслянисті багаторазові біти, і файли таблиць стилів мають місце вибрало в static/css/.

Ці структури каталогів не встановлені, оскільки обидва генератори веб-сайтів дозволяють певні налаштування. Наприклад, Jekyll дозволяє визначати колекції, а Hugo використовує набори сторінок. Ці функції дозволяють організувати вміст по-різному, але наразі давайте розглянемо, куди розмістити кілька простих сторінок.

Куди покласти вміст

Щоб створити меню сайту, яке виглядає так:

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

Вам знадобляться два розділи («Вступ» та «Додаткове використання»), що містять відповідні підрозділи.

Джекілл не є суворим щодо розташування вмісту. Він очікує сторінки в кореневій частині вашого сайту і буде створювати все, що там є. Ось як ви можете впорядкувати ці сторінки в кореневій частині сайту 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 

Ви можете змінити розташування джерела сайту у своїй конфігурації Jekyll.

У Hugo весь відтворений вміст очікується в content/папці. Це заважає Hugo намагатись відтворювати сторінки, які ви не хочете, наприклад 404.html, як вміст сайту. Ось як ви можете впорядкувати свій content/каталог у Hugo:

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

Для Гюго, _index.mdі index.mdозначають різні речі. Може бути корисно дізнатись, який саме набір сторінок потрібно для кожного розділу: Листок, у якого немає дітей, або Гілка.

Тепер, коли у вас є якесь уявлення про те, куди подіти речі, давайте розглянемо, як створити шаблон сторінки.

Як працює шаблонування

Шаблони сторінок Jekyll будуються на мові шаблонів Liquid. Він використовує фігурні дужки для утримання вихідного змінного на сторінку, такі як назви сторінки: {{ page.title }}.

У шаблонах Hugo також використовуються фігурні дужки, але вони побудовані за допомогою шаблонів Go. Синтаксис такий же, але різні: {{ .Title }}.

Шаблони Liquid і Go можуть обробляти логіку. Liquid використовує синтаксис тегів для позначення логічних операцій:

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

А Go Templates розміщує свої функції та аргументи в синтаксисі фігурних дужок:

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

Мови шаблонів дозволяють створити одну скелетну HTML-сторінку, а потім сказати генератору сайтів розміщувати змінний вміст у визначених вами областях. Давайте порівняємо два можливі defaultшаблони сторінок для Jekyll та 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.