Add jekyll-simple-i18n plugin with example

Adds in support for https://github.com/signalapp/jekyll-simple-i18n.

The plugin did not work with the github-pages gem, so github-pages was
switched with jekyll (which is what the current i18n branch does anyway).
This commit is contained in:
djoate 2019-11-18 00:09:19 +00:00 committed by GitHub
parent bef6d7c574
commit c36002d851
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 256 additions and 192 deletions

1
.gitignore vendored
View File

@ -6,3 +6,4 @@ font/assets/
font/_sass/
font/.fontcustom-manifest.json
assets/webfonts/ptio-font-preview.html
weblate-source-file.yml

View File

@ -1,11 +1,12 @@
source "https://rubygems.org"
# Install github-pages gem (https://jekyllrb.com/docs/github-pages/)
gem "github-pages", group: :jekyll_plugins
gem "jekyll", group: :jekyll_plugins
# Plugins
group :jekyll_plugins do
# example: gem "jekyll-feed", "~> 0.6"
gem "jekyll-sitemap"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem

View File

@ -1,89 +1,16 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.11.1)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.6.0)
public_suffix (>= 2.0.2, < 4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
commonmarker (0.17.13)
ruby-enum (~> 0.5)
concurrent-ruby (1.1.5)
dnsruby (1.61.3)
addressable (~> 2.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
ethon (0.12.0)
ffi (>= 1.3.0)
eventmachine (1.2.7)
execjs (2.7.0)
faraday (0.15.4)
multipart-post (>= 1.2, < 3)
ffi (1.11.1)
ffi (1.11.2)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (198)
activesupport (= 4.2.11.1)
github-pages-health-check (= 1.16.1)
jekyll (= 3.8.5)
jekyll-avatar (= 0.6.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.1.5)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.11.0)
jekyll-gist (= 1.5.0)
jekyll-github-metadata (= 2.12.1)
jekyll-mentions (= 1.4.1)
jekyll-optional-front-matter (= 0.3.0)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.2.0)
jekyll-redirect-from (= 0.14.0)
jekyll-relative-links (= 0.6.0)
jekyll-remote-theme (= 0.3.1)
jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.5.0)
jekyll-sitemap (= 1.2.0)
jekyll-swiss (= 0.4.0)
jekyll-theme-architect (= 0.1.1)
jekyll-theme-cayman (= 0.1.1)
jekyll-theme-dinky (= 0.1.1)
jekyll-theme-hacker (= 0.1.1)
jekyll-theme-leap-day (= 0.1.1)
jekyll-theme-merlot (= 0.1.1)
jekyll-theme-midnight (= 0.1.1)
jekyll-theme-minimal (= 0.1.1)
jekyll-theme-modernist (= 0.1.1)
jekyll-theme-primer (= 0.5.3)
jekyll-theme-slate (= 0.1.1)
jekyll-theme-tactile (= 0.1.1)
jekyll-theme-time-machine (= 0.1.1)
jekyll-titles-from-headings (= 0.5.1)
jemoji (= 0.10.2)
kramdown (= 1.17.0)
liquid (= 4.0.0)
listen (= 3.1.5)
mercenary (~> 0.3)
minima (= 2.5.0)
nokogiri (>= 1.8.5, < 2.0)
rouge (= 2.2.1)
terminal-table (~> 1.4)
github-pages-health-check (1.16.1)
addressable (~> 2.3)
dnsruby (~> 1.60)
octokit (~> 4.0)
public_suffix (~> 3.0)
typhoeus (~> 1.3)
html-pipeline (2.12.0)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
@ -100,97 +27,12 @@ GEM
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-avatar (0.6.0)
jekyll (~> 3.0)
jekyll-coffeescript (1.1.1)
coffee-script (~> 2.2)
coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.3.1)
commonmarker (~> 0.14)
jekyll (>= 3.7, < 5.0)
jekyll-commonmark-ghpages (0.1.5)
commonmarker (~> 0.17.6)
jekyll-commonmark (~> 1)
rouge (~> 2)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.11.0)
jekyll (~> 3.3)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-github-metadata (2.12.1)
jekyll (~> 3.4)
octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.4.1)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-optional-front-matter (0.3.0)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-readme-index (0.2.0)
jekyll (~> 3.0)
jekyll-redirect-from (0.14.0)
jekyll (~> 3.3)
jekyll-relative-links (0.6.0)
jekyll (~> 3.3)
jekyll-remote-theme (0.3.1)
jekyll (~> 3.5)
rubyzip (>= 1.2.1, < 3.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.5.0)
jekyll (~> 3.3)
jekyll-sitemap (1.2.0)
jekyll (~> 3.3)
jekyll-swiss (0.4.0)
jekyll-theme-architect (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-cayman (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-dinky (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-hacker (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-leap-day (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-merlot (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-midnight (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-minimal (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-modernist (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-primer (0.5.3)
jekyll (~> 3.5)
jekyll-github-metadata (~> 2.9)
jekyll-seo-tag (~> 2.0)
jekyll-theme-slate (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-tactile (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-time-machine (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-titles-from-headings (0.5.1)
jekyll (~> 3.3)
jekyll-watch (2.2.1)
listen (~> 3.0)
jemoji (0.10.2)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (~> 3.0)
kramdown (1.17.0)
liquid (4.0.0)
listen (3.1.5)
@ -198,51 +40,27 @@ GEM
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
mini_portile2 (2.4.0)
minima (2.5.0)
jekyll (~> 3.5)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.11.3)
multipart-post (2.1.1)
nokogiri (1.10.4)
mini_portile2 (~> 2.4.0)
octokit (4.14.0)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (3.1.1)
rb-fsevent (0.10.3)
rb-inotify (0.10.0)
ffi (~> 1.0)
rouge (2.2.1)
ruby-enum (0.7.2)
i18n
rouge (3.11.0)
ruby_dep (1.5.0)
rubyzip (1.2.3)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.8.2)
addressable (>= 2.3.5)
faraday (> 0.8, < 2.0)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (1.3.1)
ethon (>= 0.9.0)
tzinfo (1.2.5)
thread_safe (~> 0.1)
unicode-display_width (1.6.0)
PLATFORMS
ruby
DEPENDENCIES
github-pages
jekyll
jekyll-sitemap
tzinfo-data
BUNDLED WITH

View File

@ -7,7 +7,8 @@ sass:
style: compressed
plugins:
- jekyll-sitemap
plugins_dir: "./_plugins"
sitemap:
file: "/sitemap.xml"
include: [".well-known"]
exclude: ["font", "vendor"]
exclude: ["font", "vendor","weblate-source-file.yml"]

47
_data/language_map.yml Normal file
View File

@ -0,0 +1,47 @@
---
af: "Afrikaans"
az: "Azərbaycanca"
bg: "Български"
ca: "Català"
cs: "Česky"
da: "Dansk"
de: "Deutsch"
el: "Ελληνικά"
en: "English"
es: "Español"
et: "esti"
fa: "فارسی"
fi: "suomi"
fil: "Pilipino"
fr: "Français"
ga: "Gaeilge"
hr: "Hrvatski"
hu: "Magyar"
id: "Bahasa Indonesia"
it: "Italiano"
ja: "日本語"
kk: "Қазақ"
ko: "한국어"
lt: "Lietuviškai"
lv: "Latviešu"
mk: "Македонски"
ms: "Bahasa Melayu"
nb: "Norsk"
nl: "Nederlands"
pl: "Polski"
pt_BR: "Português (br)"
pt_PT: "Português (pt)"
ro: "Română"
ru: "Pусский"
sk: "Slovenčina"
sl: "Slovenščina"
sr: "српски"
sv: "svensk"
sw: "Kiswahili"
th: "ภาษาไทย"
tr: "Türkçe"
uk: "Українська"
uz: "O'zbekcha"
vi: "Tiếng Việt"
zh_CN: "简体中文"
zh_TW: "繁體中文"

13
_data/languages/en.yml Normal file
View File

@ -0,0 +1,13 @@
---
sponsors: |
Sponsors
new: |
New!
showcase_your_brand_as_a_sponsor_of_privacytools_here_and_support_our_mission_of_creating_a_world_fre: |
Showcase your brand as a sponsor of PrivacyTools here and support our mission of creating a world free of mass surveillance!
learn_more: |
Learn more...

13
_data/languages/es.yml Normal file
View File

@ -0,0 +1,13 @@
---
sponsors: |
Patrocinadores
new: |
Nuevo!
showcase_your_brand_as_a_sponsor_of_privacytools_here_and_support_our_mission_of_creating_a_world_fre: |
Presente su marca como patrocinador de PrivacyTools aquí y apoye nuestra misión de crear un mundo libre de vigilancia masiva!
learn_more: |
Conozca más...

35
_plugins/hreflang-tag.rb Normal file
View File

@ -0,0 +1,35 @@
# Copyright 2019 Signal
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module Jekyll
class HreflangTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
end
def render(context)
page = context.environments.first["page"]
site = context.registers[:site]
if page["translate"]
dir = page["src_dir"].nil? ? page["dir"] : page["src_dir"]
hreflangs = %{<link rel="alternate" hreflang="en" href="#{site.config["url"]}#{dir}" />}
site.data["languages"].each_key do |language|
hreflangs << %{<link rel="alternate" hreflang="#{language.tr('_', '-')}" href="#{site.config["url"]}/#{language}#{dir}" />}
end
end
hreflangs
end
end
end
Liquid::Template.register_tag('hreflang', Jekyll::HreflangTag)

38
_plugins/translate-tag.rb Normal file
View File

@ -0,0 +1,38 @@
# Copyright 2019 Signal
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module Jekyll
class TranslateTag < Liquid::Tag
attr_reader :text, :weblate_id
def initialize(tag_name, text, tokens)
super
@text = text.strip
@weblate_id = Weblate::ID.get(text)
end
def render(context)
page_language = context.environments.first["page"]["language"]
site = context.registers[:site]
if page_language.nil?
Weblate::SourceFile.add_entry(weblate_id, text)
text
else
translated_string = site.data["languages"][page_language][weblate_id]
translated_string.nil? ? text : translated_string.strip
end
end
end
end
Liquid::Template.register_tag('translate', Jekyll::TranslateTag)

View File

@ -0,0 +1,47 @@
# Copyright 2019 Signal
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module Jekyll
class TranslatedPage < Page
def initialize(site, base, dir, name)
@site, @base, @dir, @name = site, base, dir, name
self.process(@name)
self.data ||= {}
end
end
class TranslatedPageGenerator < Generator
def generate(site)
pages_to_translate = site.pages.select { |page| page.data["translate"] }
pages_to_translate.each do |page|
page_title = page.data['title']
page_title_weblate_id = Weblate::ID.get(page_title)
Weblate::SourceFile.add_entry(page_title_weblate_id, page_title)
site.data["languages"].each_key do |language|
translated_page = Jekyll::TranslatedPage.new(site, site.source, page.dir, page.name)
translated_page_title = site.data["languages"][language][page_title_weblate_id]
translated_page.data = page.data.clone
translated_page.data['title'] = translated_page_title.nil? ? page_title : translated_page_title.strip
translated_page.data['permalink'] = "#{language}/#{page.dir}/#{page.name}"
translated_page.data['src_dir'] = page.dir
translated_page.data['language'] = language
translated_page.content = page.content
site.pages << translated_page
end
end
end
end
end

View File

@ -0,0 +1,49 @@
# Copyright 2019 Signal
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module Weblate
class ID
def self.get(source_text)
source_text.nil? ? source_text : source_text.strip[0..100].gsub(/[^\w\d\s]/, '').tr(' ', '_').downcase
end
end
class SourceFile
class << self
def add_entry(weblate_id, source_text)
unless id_already_exists?(weblate_id) or source_text.nil?
new_entry = <<-YAML
#{weblate_id}: |
#{source_text}
YAML
File.write(weblate_source_location, new_entry, mode: 'a')
end
end
def id_already_exists?(weblate_id)
File.readlines(weblate_source_location).grep(/^#{weblate_id}: \|$/).any?
end
def refresh
File.write(weblate_source_location, "---\n")
end
def weblate_source_location
"#{__dir__}/../weblate-source-file.yml"
end
end
end
end
Jekyll::Hooks.register :site, :after_init do
Weblate::SourceFile.refresh
end

View File

@ -1,14 +1,15 @@
---
layout: default
translate: true
---
<script src="/assets/js/redirects.js"></script>
{% include sections/header.html %}
{% include sections/resources.html %}
<h1 id="sponsors" class="anchor"><a href="#sponsors"><i class="fas fa-link anchor-icon"></i></a> Sponsors</h1>
<h1 id="sponsors" class="anchor"><a href="#sponsors"><i class="fas fa-link anchor-icon"></i></a> {%translate Sponsors%}</h1>
<div class="alert alert-success" role="alert">
<strong>New!</strong> Showcase your brand as a sponsor of PrivacyTools here and support our mission of creating a world free of mass surveillance! <a href="/sponsors/" class="alert-link">Learn more...</a>
<strong>{%translate New!%}</strong> {%translate Showcase your brand as a sponsor of PrivacyTools here and support our mission of creating a world free of mass surveillance!%} <a href="/{% if page.language %}{{ page.language }}/{% endif %}sponsors/" class="alert-link">{%translate Learn more...%}</a>
</div>
{% include sections/quotes.html %}
{% include sections/privacy-resources.html %}