Post

使用Polyglot在Jekyll部落格實現多語言支援 (2) - Chirpy主題構建失敗及搜尋功能錯誤排除

介紹在基於'jekyll-theme-chirpy'的Jekyll部落格中應用Polyglot外掛實現多語言支援的過程。這篇文章是該系列的第二篇，主要討論在Chirpy主題應用Polyglot時遇到的錯誤原因識別與解決方案。

Posted Updated
Preview Image
By Yunseo Kim
views 16 min read
使用Polyglot在Jekyll部落格實現多語言支援 (2) - Chirpy主題構建失敗及搜尋功能錯誤排除

概述

大約4個月前，也就是人類紀元 12024年7月初，我在透過Github Pages託管的Jekyll部落格上應用了Polyglot外掛來實現多語言支援。 這個系列分享了在Chirpy主題上應用Polyglot外掛過程中遇到的錯誤及其解決方法，以及考慮SEO的html標頭和sitemap.xml編寫方法。 本系列共有兩篇文章，您正在閱讀的是系列中的第二篇。

需求

  • 構建的結果（網頁）應按語言路徑（例如 /posts/ko/、/posts/ja/）分類提供。
  • 為了盡量減少多語言支援所需的額外時間和精力，不必在原始markdown文件的YAML front matter中逐一指定’lang’和’permalink’標籤，而是在構建時根據文件所在的本地路徑（例如 /_posts/ko/、/_posts/ja/）自動識別語言。
  • 網站中每個頁面的標頭部分應包含適當的Content-Language元標籤和hreflang替代標籤，以滿足Google多語言搜尋的SEO指南。
  • 網站中支援每種語言的所有頁面連結應完整地在sitemap.xml中提供，而sitemap.xml本身應只存在於根路徑中，不得重複。
  • Chirpy主題提供的所有功能應在各語言頁面中正常運作，如果不正常，則需進行修改使其正常運作。
    • ‘Recently Updated’、’Trending Tags’功能正常運作
    • 使用GitHub Actions構建過程中不出現錯誤
    • 部落格右上角的文章搜尋功能正常運作

開始之前

這篇文章是第1篇的延續，如果您還沒有閱讀，建議先閱讀前一篇文章。

故障排除 (‘relative_url_regex’: target of repeat operator is not specified)

完成前面的步驟後，執行bundle exec jekyll serve命令進行構建測試時，出現了'relative_url_regex': target of repeat operator is not specified錯誤，導致構建失敗。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

...(前略)
                    ------------------------------------------------
      Jekyll 4.3.4   Please append `--trace` to the `serve` command 
                     for any additional information or backtrace. 
                    ------------------------------------------------
/Users/yunseo/.gem/ruby/3.2.2/gems/jekyll-polyglot-1.8.1/lib/jekyll/polyglot/
patches/jekyll/site.rb:234:in `relative_url_regex': target of repeat operator 
is not specified: /href="?\/((?:(?!*.gem)(?!*.gemspec)(?!tools)(?!README.md)(
?!LICENSE)(?!*.config.js)(?!rollup.config.js)(?!package*.json)(?!.sass-cache)
(?!.jekyll-cache)(?!gemfiles)(?!Gemfile)(?!Gemfile.lock)(?!node_modules)(?!ve
ndor\/bundle\/)(?!vendor\/cache\/)(?!vendor\/gems\/)(?!vendor\/ruby\/)(?!en\/
)(?!ko\/)(?!es\/)(?!pt-BR\/)(?!ja\/)(?!fr\/)(?!de\/)[^,'"\s\/?.]+\.?)*(?:\/[^
\]\[)("'\s]*)?)"/ (RegexpError)

...(後略)

搜尋類似問題後，發現Polyglot倉庫中已有完全相同的問題被報告，且已有解決方案。

本部落格使用的Chirpy主題的_config.yml文件中有以下內容：

1
2
3
4
5
6
7
8
9

exclude:
  - "*.gem"
  - "*.gemspec"
  - docs
  - tools
  - README.md
  - LICENSE
  - "*.config.js"
  - package*.json

問題的原因在於Polyglot的site.rb文件中的以下兩個函數的正則表達式無法正確處理像"*.gem"、"*.gemspec"、"*.config.js"這樣包含萬用字元的glob模式。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

    # a regex that matches relative urls in a html document
    # matches href="baseurl/foo/bar-baz" href="/zh-TW/foo/bar-baz" and others like it
    # avoids matching excluded files.  prepare makes sure
    # that all @exclude dirs have a trailing slash.
    def relative_url_regex(disabled = false)
      regex = ''
      unless disabled
        @exclude.each do |x|
          regex += "(?!#{x})"
        end
        @languages.each do |x|
          regex += "(?!#{x}\/)"
        end
      end
      start = disabled ? 'ferh' : 'href'
      %r{#{start}="?#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
    end

    # a regex that matches absolute urls in a html document
    # matches href="http://baseurl/foo/bar-baz" and others like it
    # avoids matching excluded files.  prepare makes sure
    # that all @exclude dirs have a trailing slash.
    def absolute_url_regex(url, disabled = false)
      regex = ''
      unless disabled
        @exclude.each do |x|
          regex += "(?!#{x})"
        end
        @languages.each do |x|
          regex += "(?!#{x}\/)"
        end
      end
      start = disabled ? 'ferh' : 'href'
      %r{(?<!hreflang="#{@default_lang}" )#{start}="?#{url}#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
    end

解決這個問題有兩種方法：

1. Fork Polyglot並修改問題部分

截至撰寫本文時（12024.11.），Jekyll官方文檔指出exclude設定支援Ruby的File.fnmatch文件名glob模式來匹配多個要排除的項目。

“This configuration option supports Ruby’s File.fnmatch filename globbing patterns to match multiple entries to exclude.”

也就是說，問題的根源不在Chirpy主題，而在Polyglot的relative_url_regex()和absolute_url_regex()兩個函數，因此根本解決方案是修改這些函數以避免問題發生。

由於Polyglot尚未修復此錯誤，可以參考這篇部落格文章和GitHub問題中的回覆，fork Polyglot倉庫後修改問題部分如下，然後使用修改後的版本替代原始Polyglot：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

    def relative_url_regex(disabled = false)
      regex = ''
      unless disabled
        @exclude.each do |x|
          escaped_x = Regexp.escape(x)
          regex += "(?!#{escaped_x})"
        end
        @languages.each do |x|
          escaped_x = Regexp.escape(x)
          regex += "(?!#{escaped_x}\/)"
        end
      end
      start = disabled ? 'ferh' : 'href'
      %r{#{start}="?#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
    end

    def absolute_url_regex(url, disabled = false)
      regex = ''
      unless disabled
        @exclude.each do |x|
          escaped_x = Regexp.escape(x)
          regex += "(?!#{escaped_x})"
        end
        @languages.each do |x|
          escaped_x = Regexp.escape(x)
          regex += "(?!#{escaped_x}\/)"
        end
      end
      start = disabled ? 'ferh' : 'href'
      %r{(?<!hreflang="#{@default_lang}" )#{start}="?#{url}#{@baseurl}/((?:#{regex}[^,'"\s/?.]+\.?)*(?:/[^\]\[)("'\s]*)?)"}
    end

2. 在Chirpy主題的’_config.yml’設定文件中將glob模式替換為確切的文件名

理想的方法是將上述修補程式合併到Polyglot主線中。但在此之前，需要使用fork版本，這樣每次Polyglot上游更新時都需要跟進，比較麻煩，所以我選擇了另一種方法。

檢查Chirpy主題倉庫中項目根目錄下符合"*.gem"、"*.gemspec"、"*.config.js"模式的文件，實際上只有以下3個：

  • jekyll-theme-chirpy.gemspec
  • purgecss.config.js
  • rollup.config.js

因此，可以在_config.yml文件的exclude部分刪除glob模式，改為如下具體文件名：

1
2
3
4
5
6
7
8
9

exclude: # 參考 https://github.com/untra/polyglot/issues/204 問題進行修改。
  # - "*.gem"
  - jekyll-theme-chirpy.gemspec # - "*.gemspec"
  - tools
  - README.md
  - LICENSE
  - purgecss.config.js # - "*.config.js"
  - rollup.config.js
  - package*.json

修改搜尋功能

完成前面的步驟後，大部分網站功能都按預期運作良好。然而，我後來發現Chirpy主題頁面右上角的搜尋欄無法索引site.default_lang（本部落格為英文）以外語言的頁面，且在非英文語言中搜尋時也只顯示英文頁面的搜尋結果。

為了找出原因，讓我們看看哪些文件與搜尋功能相關，以及問題出在哪裡。

‘_layouts/default.html’

檢查構成部落格所有頁面框架的_layouts/default.html文件，可以看到在<body>元素內載入了search-results.html和search-loader.html的內容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

  <body>
    {% include sidebar.html lang=lang %}

    <div id="main-wrapper" class="d-flex justify-content-center">
      <div class="container d-flex flex-column px-xxl-5">
        
        (...中略...)

        {% include_cached search-results.html lang=lang %}
      </div>

      <aside aria-label="Scroll to Top">
        <button id="back-to-top" type="button" class="btn btn-lg btn-box-shadow">
          <i class="fas fa-angle-up"></i>
        </button>
      </aside>
    </div>

    (...中略...)

    {% include_cached search-loader.html lang=lang %}
  </body>

‘_includes/search-result.html’

_includes/search-result.html構建了一個search-results容器，用於在搜尋框輸入關鍵字時存儲該關鍵字的搜尋結果。

1
2
3
4
5
6
7
8
9
10

<!-- The Search results -->

<div id="search-result-wrapper" class="d-flex justify-content-center d-none">
  <div class="col-11 content">
    <div id="search-hints">
      {% include_cached trending-tags.html %}
    </div>
    <div id="search-results" class="d-flex flex-wrap justify-content-center text-muted mt-3"></div>
  </div>
</div>

‘_includes/search-loader.html’

_includes/search-loader.html是基於Simple-Jekyll-Search庫實現搜尋功能的核心部分，它在訪問者的瀏覽器中執行JavaScript，從search.json索引文件中找出與輸入關鍵字匹配的部分，並以<article>元素形式返回相應文章連結，實現客戶端搜尋。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{% capture result_elem %}
  <article class="px-1 px-sm-2 px-lg-4 px-xl-0">
    <header>
      <h2><a href="{url}">{title}</a></h2>
      <div class="post-meta d-flex flex-column flex-sm-row text-muted mt-1 mb-1">
        {categories}
        {tags}
      </div>
    </header>
    <p>{snippet}</p>
  </article>
{% endcapture %}

{% capture not_found %}<p class="mt-5">{{ site.data.locales[include.lang].search.no_results }}</p>{% endcapture %}

<script>
  {% comment %} Note: dependent library will be loaded in `js-selector.html` {% endcomment %}
  document.addEventListener('DOMContentLoaded', () => {
    SimpleJekyllSearch({
      searchInput: document.getElementById('search-input'),
      resultsContainer: document.getElementById('search-results'),
      json: '{{ '/assets/js/data/search.json' | relative_url }}',
      searchResultTemplate: '{{ result_elem | strip_newlines }}',
      noResultsText: '{{ not_found }}',
      templateMiddleware: function(prop, value, template) {
        if (prop === 'categories') {
          if (value === '') {
            return `${value}`;
          } else {
            return `<div class="me-sm-4"><i class="far fa-folder fa-fw"></i>${value}</div>`;
          }
        }

        if (prop === 'tags') {
          if (value === '') {
            return `${value}`;
          } else {
            return `<div><i class="fa fa-tag fa-fw"></i>${value}</div>`;
          }
        }
      }
    });
  });
</script>

‘/assets/js/data/search.json’

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

---
layout: compress
swcache: true
---

[
  {% for post in site.posts %}
  {
    "title": {{ post.title | jsonify }},
    "url": {{ post.url | relative_url | jsonify }},
    "categories": {{ post.categories | join: ', ' | jsonify }},
    "tags": {{ post.tags | join: ', ' | jsonify }},
    "date": "{{ post.date }}",
    {% include no-linenos.html content=post.content %}
    {% assign _content = content | strip_html | strip_newlines %}
    "snippet": {{ _content | truncate: 200 | jsonify }},
    "content": {{ _content | jsonify }}
  }{% unless forloop.last %},{% endunless %}
  {% endfor %}
]

使用Jekyll的Liquid語法定義了一個JSON文件，包含網站中所有文章的標題、URL、分類和標籤信息、發布日期、前200字摘要以及全文內容。

搜尋功能運作結構及問題識別

總結來說，在GitHub Pages上託管Chirpy主題時，搜尋功能按以下流程運作：

stateDiagram
  state "Changes" as CH
  state "Build start" as BLD
  state "Create search.json" as IDX
  state "Static Website" as DEP
  state "In Test" as TST
  state "Search Loader" as SCH
  state "Results" as R
    
  [*] --> CH: Make Changes
  CH --> BLD: Commit & Push origin
  BLD --> IDX: jekyll build
  IDX --> TST: Build Complete
  TST --> CH: Error Detected
  TST --> DEP: Deploy
  DEP --> SCH: Search Input
  SCH --> R: Return Results
  R --> [*]

我確認search.json被Polyglot按以下語言分別生成：

  • /assets/js/data/search.json
  • /ko/assets/js/data/search.json
  • /es/assets/js/data/search.json
  • /pt-BR/assets/js/data/search.json
  • /ja/assets/js/data/search.json
  • /fr/assets/js/data/search.json
  • /de/assets/js/data/search.json

因此，問題出在”Search Loader”部分。非英文頁面無法被搜尋到的問題是因為_includes/search-loader.html無論當前訪問頁面的語言是什麼，都只靜態加載英文索引文件（/assets/js/data/search.json）。

因此，索引文件中的title、snippet、content等值會根據語言不同而生成不同內容，但url值返回的是不考慮語言的基本路徑，需要在”Search Loader”部分添加適當處理。

問題解決

要解決這個問題，需要修改_includes/search-loader.html的內容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{% capture result_elem %}
  <article class="px-1 px-sm-2 px-lg-4 px-xl-0">
    <header>
      {% if site.active_lang != site.default_lang %}
      <h2><a {% static_href %}href="/{{ site.active_lang }}{url}"{% endstatic_href %}>{title}</a></h2>
      {% else %}
      <h2><a href="{url}">{title}</a></h2>
      {% endif %}

(...中略...)

<script>
  {% comment %} Note: dependent library will be loaded in `js-selector.html` {% endcomment %}
  document.addEventListener('DOMContentLoaded', () => {
    {% assign search_path = '/assets/js/data/search.json' %}
    {% if site.active_lang != site.default_lang %}
      {% assign search_path = '/' | append: site.active_lang | append: search_path %}
    {% endif %}
    
    SimpleJekyllSearch({
      searchInput: document.getElementById('search-input'),
      resultsContainer: document.getElementById('search-results'),
      json: '{{ search_path | relative_url }}',
      searchResultTemplate: '{{ result_elem | strip_newlines }}',

(...後略)
  • 當site.active_lang（當前頁面語言）與site.default_lang（網站默認語言）不同時，在從JSON文件加載的文章URL前添加"/{{ site.active_lang }}"前綴，修改了{% capture result_elem %}部分的liquid語法。
  • 同樣，在構建過程中比較當前頁面語言和網站默認語言，如果相同則使用默認路徑（/assets/js/data/search.json），如果不同則使用對應語言的路徑（例如/ko/assets/js/data/search.json）作為search_path，修改了<script>部分。

進行上述修改後重新構建網站，確認各語言的搜尋結果都能正常顯示。

{url}是JSON文件中讀取的URL值的佔位符，而非URL本身，因此Polyglot不會將其識別為本地化目標，需要根據語言直接處理。問題是處理後的"/{{ site.active_lang }}{url}"會被識別為URL，雖然已完成本地化，但Polyglot不知道這一點，會嘗試重複本地化（例如"/ko/ko/posts/example-post"）。為防止這種情況，使用了{% static_href %}標籤。

AI & Data, Blogging
Jekyll Polyglot Markdown
This post is licensed under CC BY-NC 4.0 by the author.