jekyll-multiple-languages-plugin 1.5.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f0345608e574787a5648224db9b1384ecce2152
-  data.tar.gz: 254fca0b56af9ce8ac43441e1d6bd7927ed4305b
+SHA256:
+  metadata.gz: 7d2f78a4cba9b1b00c236740a245bbc561cbf9740b330830a2464129ce44b818
+  data.tar.gz: 4efb2e419030c21a53ca1f3b38018bf31681a74e8c57fb4592ee375c6783a5e9
 SHA512:
-  metadata.gz: 2d9a024e2b68882f4ecd9e9d4c1b110e081ed7459ef0ac027e85020e8544576578ecf5347cf9b7a4b1e3458f2820ea7e6dee4c180ec99a137f39de69481ea209
-  data.tar.gz: ef680666a151cd316cc0171a2c8e501c466e9b65197dc20f7563fddea7ed21d1cecd37f5b208386cb89f01c550e8f336676d62f010ab81c1cb5769610baba3de
+  metadata.gz: 00f559010eec5ac54b67d651b8f77a06cc0004fc63a631aca402754dfc3b8b900fea14687c8b99f40c0156aef66146f70babdb9dd78d86b4ca9364268a80c629
+  data.tar.gz: 870ec29d2941d9f08be8c21e179703fa6ca58ec3b8c15f00ab663ab54e5b8501a02b5bea47a43a80c271e3d8450f20e839098b2971539d6c37879991c0493cb4

data/LICENSE.txt

@@ -1,353 +1,9 @@
-Mozilla Public License Version 2.0
-==================================
+MIT License
 
-1. Definitions
---------------
+Copyright (c) 2014 Martin Kurtsson
 
-1.1. "Contributor"
-    means  each  individual  or  legal  entity  that creates, contributes to the
-    creation of, or owns Covered Software.
+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:
 
-1.2. "Contributor Version"
-    means  the  combination  of  the  Contributions of others (if any) used by a
-    Contributor and that particular Contributor's Contribution.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-1.3. "Contribution"
-    means Covered Software of a particular Contributor.
-
-1.4. "Covered Software"
-    means  Source  Code  Form  to which the initial Contributor has attached the
-    notice  in  Exhibit  A,  the  Executable  Form of such Source Code Form, and
-    Modifications  of  such  Source  Code  Form, in each case including portions
-    thereof.
-
-1.5. "Incompatible With Secondary Licenses"
-    means
-
-    (a) that  the  initial  Contributor  has  attached  the  notice described in
-        Exhibit B to the Covered Software; or
-
-    (b) that  the Covered Software was made available under the terms of version
-        1.1  or  earlier  of  the  License,  but  not  also under the terms of a
-        Secondary License.
-
-1.6. "Executable Form"
-    means any form of the work other than Source Code Form.
-
-1.7. "Larger Work"
-    means  a  work  that  combines  Covered  Software  with other material, in a
-    separate file or files, that is not Covered Software.
-
-1.8. "License"
-    means this document.
-
-1.9. "Licensable"
-    means  having the right to grant, to the maximum extent possible, whether at
-    the  time  of  the  initial grant or subsequently, any and all of the rights
-    conveyed by this License.
-
-1.10. "Modifications"
-    means any of the following:
-
-    (a) any  file in Source Code Form that results from an addition to, deletion
-        from, or modification of the contents of Covered Software; or
-
-    (b) any new file in Source Code Form that contains any Covered Software.
-
-1.11. "Patent Claims" of a Contributor
-    means  any  patent  claim(s), including without limitation, method, process,
-    and  apparatus  claims,  in  any  patent Licensable by such Contributor that
-    would  be infringed, but for the grant of the License, by the making, using,
-    selling,  offering  for sale, having made, import, or transfer of either its
-    Contributions or its Contributor Version.
-
-1.12. "Secondary License"
-    means  either  the  GNU  General Public License, Version 2.0, the GNU Lesser
-    General  Public License, Version 2.1, the GNU Affero General Public License,
-    Version 3.0, or any later versions of those licenses.
-
-1.13. "Source Code Form"
-    means the form of the work preferred for making modifications.
-
-1.14. "You" (or "Your")
-    means an individual or a legal entity exercising rights under this License.
-    For  legal  entities, "You" includes any entity that controls, is controlled
-    by,  or  is  under common control with You. For purposes of this definition,
-    "control" means (a) the power, direct or indirect, to cause the direction or
-    management  of  such  entity,  whether  by  contract  or  otherwise,  or (b)
-    ownership  of  more  than  fifty  percent (50%) of the outstanding shares or
-    beneficial ownership of such entity.
-
-2. License Grants and Conditions
---------------------------------
-
-2.1. Grants
-
-Each  Contributor  hereby  grants  You a world-wide, royalty-free, non-exclusive
-license:
-
-(a) under   intellectual  property  rights  (other  than  patent  or  trademark)
-    Licensable  by  such  Contributor to use, reproduce, make available, modify,
-    display,  perform,  distribute,  and  otherwise  exploit  its Contributions,
-    either  on  an  unmodified basis, with Modifications, or as part of a Larger
-    Work; and
-
-(b) under  Patent Claims of such Contributor to make, use, sell, offer for sale,
-    have  made,  import,  and otherwise transfer either its Contributions or its
-    Contributor Version.
-
-2.2. Effective Date
-
-The  licenses  granted  in  Section  2.1 with respect to any Contribution become
-effective  for  each  Contribution on the date the Contributor first distributes
-such Contribution.
-
-2.3. Limitations on Grant Scope
-
-The  licenses  granted  in this Section 2 are the only rights granted under this
-License.  No additional rights or licenses will be implied from the distribution
-or  licensing  of  Covered  Software under this License. Notwithstanding Section
-2.1(b) above, no patent license is granted by a Contributor:
-
-(a) for any code that a Contributor has removed from Covered Software;
-    or
-
-(b) for   infringements  caused  by:  (i)  Your  and  any  other  third  party's
-    modifications   of   Covered  Software,  or  (ii)  the  combination  of  its
-    Contributions  with  other  software  (except  as  part  of  its Contributor
-    Version); or
-
-(c) under  Patent  Claims  infringed  by  Covered Software in the absence of its
-    Contributions.
-
-This  License  does  not  grant  any rights in the trademarks, service marks, or
-logos  of  any Contributor (except as may be necessary to comply with the notice
-requirements in Section 3.4).
-
-2.4. Subsequent Licenses
-
-No  Contributor makes additional grants as a result of Your choice to distribute
-the  Covered  Software  under  a subsequent version of this License (see Section
-10.2) or under the terms of a Secondary License (if permitted under the terms of
-Section 3.3).
-
-2.5. Representation
-
-Each  Contributor represents that the Contributor believes its Contributions are
-its  original creation(s) or it has sufficient rights to grant the rights to its
-Contributions conveyed by this License.
-
-2.6. Fair Use
-
-This  License  is  not  intended  to  limit any rights You have under applicable
-copyright doctrines of fair use, fair dealing, or other equivalents.
-
-2.7. Conditions
-
-Sections  3.1,  3.2,  3.3,  and  3.4  are  conditions of the licenses granted in
-Section 2.1.
-
-3. Responsibilities
--------------------
-
-3.1. Distribution of Source Form
-
-All  distribution  of  Covered  Software  in  Source  Code  Form,  including any
-Modifications  that  You  create  or  to which You contribute, must be under the
-terms  of  this License. You must inform recipients that the Source Code Form of
-the  Covered Software is governed by the terms of this License, and how they can
-obtain  a  copy  of  this  License. You may not attempt to alter or restrict the
-recipients' rights in the Source Code Form.
-
-3.2. Distribution of Executable Form
-
-If You distribute Covered Software in Executable Form then:
-
-(a) such  Covered  Software  must also be made available in Source Code Form, as
-    described  in  Section 3.1, and You must inform recipients of the Executable
-    Form how they can obtain a copy of such Source Code Form by reasonable means
-    in a timely manner, at a charge no more than the cost of distribution to the
-    recipient; and
-
-(b) You  may distribute such Executable Form under the terms of this License, or
-    sublicense  it  under  different  terms,  provided  that the license for the
-    Executable Form does not attempt to limit or alter the recipients' rights in
-    the Source Code Form under this License.
-
-3.3. Distribution of a Larger Work
-
-You may create and distribute a Larger Work under terms of Your choice, provided
-that  You  also  comply  with  the  requirements of this License for the Covered
-Software.  If  the  Larger Work is a combination of Covered Software with a work
-governed  by  one  or  more  Secondary Licenses, and the Covered Software is not
-Incompatible  With  Secondary Licenses, this License permits You to additionally
-distribute  such  Covered Software under the terms of such Secondary License(s),
-so  that  the  recipient  of  the  Larger  Work  may,  at  their option, further
-distribute  the  Covered Software under the terms of either this License or such
-Secondary License(s).
-
-3.4. Notices
-
-You  may  not  remove  or  alter the substance of any license notices (including
-copyright  notices,  patent  notices, disclaimers of warranty, or limitations of
-liability) contained within the Source Code Form of the Covered Software, except
-that  You  may  alter any license notices to the extent required to remedy known
-factual inaccuracies.
-
-3.5. Application of Additional Terms
-
-You  may  choose to offer, and to charge a fee for, warranty, support, indemnity
-or liability obligations to one or more recipients of Covered Software. However,
-You may do so only on Your own behalf, and not on behalf of any Contributor. You
-must  make  it  absolutely  clear that any such warranty, support, indemnity, or
-liability  obligation is offered by You alone, and You hereby agree to indemnify
-every  Contributor for any liability incurred by such Contributor as a result of
-warranty,  support,  indemnity  or  liability  terms  You offer. You may include
-additional  disclaimers of warranty and limitations of liability specific to any
-jurisdiction.
-
-4. Inability to Comply Due to Statute or Regulation
----------------------------------------------------
-
-If it is impossible for You to comply with any of the terms of this License with
-respect  to  some or all of the Covered Software due to statute, judicial order,
-or  regulation  then  You must: (a) comply with the terms of this License to the
-maximum  extent  possible;  and  (b)  describe the limitations and the code they
-affect.  Such  description  must  be  placed  in  a  text file included with all
-distributions  of  the Covered Software under this License. Except to the extent
-prohibited  by  statute  or  regulation,  such  description must be sufficiently
-detailed for a recipient of ordinary skill to be able to understand it.
-
-5. Termination
---------------
-
-5.1. The  rights  granted under this License will terminate automatically if You
-fail to comply with any of its terms. However, if You become compliant, then the
-rights  granted  under this License from a particular Contributor are reinstated
-(a)  provisionally,  unless  and  until  such Contributor explicitly and finally
-terminates  Your  grants, and (b) on an ongoing basis, if such Contributor fails
-to  notify  You  of the non-compliance by some reasonable means prior to 60 days
-after  You  have  come  back  into  compliance.  Moreover,  Your  grants  from a
-particular  Contributor  are  reinstated on an ongoing basis if such Contributor
-notifies  You  of the non-compliance by some reasonable means, this is the first
-time  You  have  received  notice  of non-compliance with this License from such
-Contributor, and You become compliant prior to 30 days after Your receipt of the
-notice.
-
-5.2. If  You  initiate  litigation  against  any  entity  by  asserting a patent
-infringement  claim (excluding declaratory judgment actions, counter-claims, and
-cross-claims)  alleging  that  a  Contributor  Version  directly  or  indirectly
-infringes any patent, then the rights granted to You by any and all Contributors
-for the Covered Software under Section 2.1 of this License shall terminate.
-
-5.3. In  the  event of termination under Sections 5.1 or 5.2 above, all end user
-license  agreements  (excluding  distributors  and  resellers)  which  have been
-validly  granted  by  You  or  Your  distributors  under  this  License prior to
-termination shall survive termination.
-
-********************************************************************************
-*                                                                              *
-*  6. Disclaimer of Warranty                                                   *
-*  -------------------------                                                   *
-*                                                                              *
-*  Covered  Software  is  provided  under  this  License on an "as is" basis,  *
-*  without  warranty  of  any  kind, either expressed, implied, or statutory,  *
-*  including,  without  limitation,  warranties  that the Covered Software is  *
-*  free   of   defects,   merchantable,   fit  for  a particular  purpose  or  *
-*  non-infringing.  The entire  risk as to the quality and performance of the  *
-*  Covered  Software is with You. Should any Covered Software prove defective  *
-*  in any respect, You (not any Contributor) assume the cost of any necessary  *
-*  servicing,  repair, or correction. This disclaimer of warranty constitutes  *
-*  an  essential  part  of  this  License.  No use of any Covered Software is  *
-*  authorized under this License except under this disclaimer.                 *
-*                                                                              *
-********************************************************************************
-
-********************************************************************************
-*                                                                              *
-*  7. Limitation of Liability                                                  *
-*  --------------------------                                                  *
-*                                                                              *
-*  Under  no circumstances and under no legal theory, whether tort (including  *
-*  negligence),  contract, or otherwise, shall any Contributor, or anyone who  *
-*  distributes  Covered Software as permitted above, be liable to You for any  *
-*  direct,  indirect,  special,  incidental,  or consequential damages of any  *
-*  character including, without limitation, damages for lost profits, loss of  *
-*  goodwill,  work  stoppage, computer failure or malfunction, or any and all  *
-*  other  commercial  damages  or  losses, even if such party shall have been  *
-*  informed  of the possibility of such damages. This limitation of liability  *
-*  shall  not  apply to liability for death or personal injury resulting from  *
-*  such  party's  negligence  to  the  extent  applicable  law prohibits such  *
-*  limitation. Some jurisdictions do not allow the exclusion or limitation of  *
-*  incidental  or consequential damages, so this exclusion and limitation may  *
-*  not apply to You.                                                           *
-*                                                                              *
-********************************************************************************
-
-8. Litigation
--------------
-
-Any  litigation  relating to this License may be brought only in the courts of a
-jurisdiction  where  the defendant maintains its principal place of business and
-such  litigation  shall  be  governed  by  laws  of  that  jurisdiction, without
-reference  to  its  conflict-of-law  provisions.  Nothing  in this Section shall
-prevent a party's ability to bring cross-claims or counter-claims.
-
-9. Miscellaneous
-----------------
-
-This  License  represents  the  complete agreement concerning the subject matter
-hereof.  If  any  provision  of  this  License is held to be unenforceable, such
-provision shall be reformed only to the extent necessary to make it enforceable.
-Any  law  or  regulation which provides that the language of a contract shall be
-construed against the drafter shall not be used to construe this License against
-a Contributor.
-
-10. Versions of the License
----------------------------
-
-10.1. New Versions
-
-Mozilla  Foundation  is the license steward. Except as provided in Section 10.3,
-no  one  other  than  the license steward has the right to modify or publish new
-versions  of  this  License. Each version will be given a distinguishing version
-number.
-
-10.2. Effect of New Versions
-
-You  may  distribute  the Covered Software under the terms of the version of the
-License  under  which You originally received the Covered Software, or under the
-terms of any subsequent version published by the license steward.
-
-10.3. Modified Versions
-
-If  you  create  software not governed by this License, and you want to create a
-new license for such software, you may create and use a modified version of this
-License  if  you rename the license and remove any references to the name of the
-license  steward  (except  to  note that such modified license differs from this
-License).
-
-10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
-
-If You choose to distribute Source Code Form that is Incompatible With Secondary
-Licenses under the terms of this version of the License, the notice described in
-Exhibit B of this License must be attached.
-
-Exhibit A - Source Code Form License Notice
--------------------------------------------
-
-  This  Source  Code Form is subject to the terms of the Mozilla Public License,
-  v. 2.0.  If  a  copy  of  the  MPL was not distributed with this file, You can
-  obtain one at http://mozilla.org/MPL/2.0/.
-
-If  it is not possible or desirable to put the notice in a particular file, then
-You  may  include the notice in a location (such as a LICENSE file in a relevant
-directory) where a recipient would be likely to look for such a notice.
-
-You may add additional accurate notices of copyright ownership.
-
-Exhibit B - "Incompatible With Secondary Licenses" Notice
----------------------------------------------------------
-
-  This Source Code Form is "Incompatible With Secondary Licenses", as defined by
-  the Mozilla Public License, v. 2.0.
+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.

data/README.md

@@ -4,48 +4,56 @@
 
 Jekyll Multiple Languages is an internationalization plugin for [Jekyll](https://github.com/mojombo/jekyll). It compiles your Jekyll site for one or more languages with a similar approach as Rails does. The different sites will be stored in subfolders with the same name as the language it contains.
 
-The plugin was developed as a utility at [Screen Interaction](http://www.screeninteraction.com)
+The plugin was developed as a utility at [Daresay](https://daresay.co)
 
-### Gem [![Gem Version](https://badge.fury.io/rb/jekyll-multiple-languages-plugin.png)](http://badge.fury.io/rb/jekyll-multiple-languages-plugin)
+### Badges
+[![Build Status](https://travis-ci.com/kurtsson/jekyll-multiple-languages-plugin.svg?branch=master)](https://travis-ci.com/kurtsson/jekyll-multiple-languages-plugin)
+[![Gem Version](https://badge.fury.io/rb/jekyll-multiple-languages-plugin.png)](http://badge.fury.io/rb/jekyll-multiple-languages-plugin)
 
+## !! We are looking for more maintainers !!
+
+Are you using this plugin? Could you test and verify incoming PRs? Please give us a shout!
 
 
 Table of Contents
 -----------------
-* [1\. Current Release Notice](#1-current-release-notice)
-* [2\. Features](#2-features)
-* [3\. Installation](#3-installation)
-  * [3\.1\. Using the gem](#31-using-the-gem)
-  * [3\.2\. Manually](#32-manually)
-  * [3\.3\. As a Git Submodule](#33-as-a-git-submodule)
-* [4\. Configuration](#4-configuration)
-  * [4\.1\. \_config\.yml](#41-_configyml)
-  * [4\.2\. Folder structure](#42-folder-structure)
-* [5\. Usage](#5-usage)
-  * [5\.1\. Translating strings](#51-translating-strings)
-  * [5\.2\. Including translated files](#52-including-translated-files)
-  * [5\.3\. Permalinks and Translating Links](#53-permalinks-and-translating-links)
-  * [5\.4\. i18n in templates](#54-i18n-in-templates)
-  * [5\.5\. Link between languages](#55-link-between-languages)
-  * [5\.6\. Creating pages](#56-creating-pages)
-* [7\. Example website](#7-example-website)
-  * [7\.1\. Adding a new language](#71-adding-a-new-language)
-  * [7\.2\. Adding new page](#72-adding-new-page)
-* [8\. Changelog](#8-changelog)
-* [9\. Contributing](#9-contributing)
-  * [Contributors](#contributors)
-  * [Created by](#created-by)
-  * [Maintained by](#maintained-by)
-* [10\. Other Language Plugins](#10-other-language-plugins)
+- [Jekyll Multiple Languages Plugin](#jekyll-multiple-languages-plugin)
+    - [Badges](#badges)
+  - [!! We are looking for more maintainers !!](#-we-are-looking-for-more-maintainers-)
+  - [Table of Contents](#table-of-contents)
+  - [1. Current Release Notice](#1-current-release-notice)
+  - [2. Features](#2-features)
+  - [3. Installation](#3-installation)
+    - [3.1. Using the gem](#31-using-the-gem)
+    - [3.2. Manually](#32-manually)
+    - [3.3. As a Git Submodule](#33-as-a-git-submodule)
+  - [4. Configuration](#4-configuration)
+    - [4.1. _config.yml](#41-_configyml)
+    - [4.2. Folder structure](#42-folder-structure)
+  - [5. Usage](#5-usage)
+    - [5.1. Translating strings](#51-translating-strings)
+    - [5.2. Including translated files](#52-including-translated-files)
+    - [5.3. Permalinks and Translating Links](#53-permalinks-and-translating-links)
+    - [5.4. i18n in templates](#54-i18n-in-templates)
+    - [5.5. Link between languages](#55-link-between-languages)
+    - [5.6. Creating pages](#56-creating-pages)
+    - [5.7. Creating posts](#57-creating-posts)
+    - [5.8. Select pages to translations](#58-select-pages-to-translations)
+  - [6. License](#6-license)
+  - [7. Example website](#7-example-website)
+    - [7.1. Adding a new language](#71-adding-a-new-language)
+    - [7.2. Adding new page](#72-adding-new-page)
+  - [8. Changelog](#8-changelog)
+  - [9. Contributing](#9-contributing)
+    - [Contributors](#contributors)
+    - [Created by](#created-by)
+    - [Maintained by](#maintained-by)
+    - [Former maintainer](#former-maintainer)
+  - [10. Other Language Plugins](#10-other-language-plugins)
 
 ## 1. Current Release Notice
 
-1.5.1 is the current stable release.
-
-Users that update from older versions to 1.4.0 or newer must change their `_config.yml` for the plugin to be loaded. Please see the `Installation` section bellow for the new string used to load the plugin.
-
-The plugin now works with Jekyll 3, but it's backward compatible with Jekyll 2.
-Please note that it was only tested with Jekyll 2.5.3 and 3.1.3.
+1.6.0 is the current stable release.
 
 The support for Octopress is dropped, but the plugin should still work with it since Octopress core is Jekyll.
 Octopress 3 now has its own multi languages plugin: https://github.com/octopress/multilingual
@@ -53,7 +61,6 @@ Octopress 3 now has its own multi languages plugin: https://github.com/octopress
 
 
 ## 2. Features
-* Works with Jekyll 2.5.3 and 3.1.3
 * Supports multiple languages with the same code base.
 * Supports all template languages that your Liquid pipeline supports.
 * Uses [Liquid tags](https://github.com/Shopify/liquid) in your HTML for including translated strings.
@@ -82,10 +89,10 @@ And then execute: `$ bundle install`
 
 Or install it yourself as: `$ gem install jekyll-multiple-languages-plugin`
 
-To activate the plugin add it to the Jekyll `_config.yml` file, under the `gems` option:
+To activate the plugin add it to the Jekyll `_config.yml` file, under the `plugins` option:
 
 ```ruby
-gems: 
+plugins:
   - jekyll-multiple-languages-plugin
 ```
 See the [Jekyll configuration documentation](http://jekyllrb.com/docs/configuration) for details.
@@ -135,6 +142,12 @@ In code, these specific files should be referenced via `baseurl_root`. E.g.
 <link rel="stylesheet" href="{{ "/css/bootstrap.css" | prepend: site.baseurl_root }}"/>
 ```
 
+If you wish to avoid having the default_lang built into the root of your website, use:
+
+```yaml
+default_locale_in_subfolder: true
+```
+
 ### 4.2. Folder structure
 Create a folder called `_i18n` and add sub-folders for each language, using the same names used on the `languages` setting on the `_config.yml`:
 
@@ -172,7 +185,7 @@ pages:
   work: Work
 ```
 
-  To access the `english` key, use one of these tag:
+  To access the `english` key, use one of these tags:
 
 ```liquid
 {% t global.english %}
@@ -180,14 +193,36 @@ or
 {% translate global.english %}
 ```
 
-You can also access translated strings by accesing the `site.translations` hash, this allows you to loop trough your translations within Liquid:
+You can also access translated strings by accessing the `site.translations` hash, this allows you to loop through your translations within Liquid using the translated string's index:
 
 ```liquid
-{% for item in site.translations[site.lang]["my_nested_yaml_collection"] %}
+{% for item in site.translations[site.lang].my_nested_yaml_collection %}
     <p>{{ item[0] }} -> {{ item[1] }}</p>
 {% endfor %}
 ```
 
+or the translated string's assignment:
+
+```yaml
+my_nested_yaml_collection:
+  -
+    title: First
+    message: Message
+  -
+    title: Second
+    message: Message
+
+```
+
+```liquid
+{% for item in site.translations[site.lang].my_nested_yaml_collection %}
+   <li>
+      <h2>{{ item["title"] }}</h2>
+      <p>{{ item["message"] }}</p>
+   </li>
+{% endfor %}
+```
+
 ### 5.2. Including translated files
 The plugin also supports using different markdown files for different languages using the liquid tag:
 
@@ -272,7 +307,7 @@ titles:
 This plugin gives you the variables
 
 ```liquid
-{{ page.lang }}
+{{ site.lang }}
 
 and
 
@@ -286,7 +321,7 @@ This allows you to create solutions like this:
 
 ``` liquid
 {% if site.lang == "sv" %}
-  {% capture link1 %}{{ site.baseurl_root }}en{{ page.url}}{% endcapture %}
+  {% capture link1 %}{{ site.baseurl_root }}/en{{ page.url}}{% endcapture %}
   <a href="{{ link1 }}" >{% t global.english %}</a>
 {% elsif site.lang == "en" %}
   {% capture link2 %}{{ site.baseurl_root }}{{ page.url  }}{% endcapture %}
@@ -322,6 +357,31 @@ Inside each of the language folders, you should create mirror pages to provide t
 
 
 
+### 5.7. Creating posts
+There are no global posts. The posts are localized by language. And your posts will live in the `_i18n/[lang]/_posts` directory. So if, for example, you have English language on your website you should put your posts on `_i18n/en/_posts` directory.
+
+
+
+### 5.8. Select pages to translations
+
+Sometimes you want to generate only selected versions of the page, especially excluding default language. You can do this using languages tag.
+
+Example:
+```yaml
+---
+permalink:      /team/
+permalink_fr:   /equipe/
+
+languages: ["fr"]
+---
+```
+
+This generate only french version of the page.
+
+## 6. License
+
+This project is available under the [MIT License](LICENSE.txt).
+
 ## 7. Example website
 
 This repository has an example website where you can test the plugin.
@@ -355,8 +415,25 @@ permalink: /about/
 Then, create a file named `about.md` under `_i18n/en` with the English content. Repeat this for the other languages (_i18n/es/about.md ...). When running the website, visit the address `http://localhost:4000/about` to see the English version, `http://localhost:4000/es/about` for the Spanish one, etc.
 
 
-
 ## 8. Changelog
+* 1.8.0
+  * I18n for site and Front Matter configurations [@pgoltsev](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/125)
+* 1.7.0
+  * Option to build the default language into a subfolder
+  * Configurable verbosity
+  * Improved documentation
+  * Removed deprecation warning
+* 1.6.1
+  * Improved testing
+  * Support for Jekyll 4
+  * Russian examples
+  * Translations rebuilt every time page is reloaded in developer mode
+* 1.6.0
+  * fix: check if static_file_r_path is set
+  * Missing slash before lang prefix in lang picker example
+  * Updated README.md with _posts directory
+  * Build translations in pre_render hook
+  * If include not found, fall back to default language
 * 1.5.1
   * Fix a bug (#70) where `site.static_files` would be empty on subsites if `exclude_from_localizations` is used.
   * Some overall project enhancements and minor fixes.
@@ -369,8 +446,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 * 1.4.1
   * Fixes a bug during site regeneration where translation paths were being nested based on wrongly set Jekyll variables.
 * 1.4.0
-  * Support for Jekyll 3, thanks to [@pedrocarmona](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/62)
-  * How to create pages documentation, thanks to [@elotroalex](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/57)
+  * Support for Jekyll 3, thanks to [@pedrocarmona](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/62)
+  * How to create pages documentation, thanks to [@elotroalex](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/57)
   * Many bug fixes
   * Code refactoring, cleanup and reorganization
   * Files and folders reorganization
@@ -378,8 +455,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
   * Improvements and fixes on documentations
   * Improved license files
 * 1.3.0
-  * Support for localized links and custom permalinks, thanks to [@jasonlemay](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/53)
-  * Support for excluding posts from translation, thanks to [@ctruelson](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/51)
+  * Support for localized links and custom permalinks, thanks to [@jasonlemay](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/53)
+  * Support for excluding posts from translation, thanks to [@ctruelson](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/51)
 * 1.2.9
   * Bug fix when excluding files from translation, again thanks to [@h6](https://github.com/H6)
 * 1.2.8
@@ -422,6 +499,7 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 ### Contributors
 | User                                             | Contribution                         |
 | :----------------------------------------------- | :----------------------------------- |
+| [@pgoltsev](https://github.com/pgoltsev)         | version 1.8.0
 | [@pedrocarmona](https://github.com/pedrocarmona) | support for Jekyll 3                 |
 | [@elotroalex](https://github.com/elotroalex)     | added a how to create page to README |
 | [@mohamnag](https://github.com/mohamnag)         | permalink generation bug fix         |
@@ -434,29 +512,28 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 | [@leoditommaso](https://github.com/leoditommaso) | update the example page              |
 
 ### Created by
-[@kurtsson](https://github.com/kurtsson) from [Screen Interaction](https://github.com/screeninteraction) (http://screeninteraction.com)
-
+[@kurtsson](https://github.com/kurtsson) from [Daresay](https://github.com/daresaydigital) (https://daresay.co)
 
 ### Maintained by
-- [@kurtsson](https://github.com/kurtsson)
+- [@shushugah](https://github.com/shushugah)
+
+### Former maintainer
 - [@Anthony-Gaudino](https://github.com/Anthony-Gaudino)
 
 
 
 ## 10. Other Language Plugins
-Bellow is a list of other language plugins for Jekyll (2016/05/28):
+Below is a list of other language plugins for Jekyll (2019/06/27):
 
 **Seems to be maintained:**
-
-* [Jekyll Language Plugin](https://github.com/vwochnik/jekyll-language-plugin)
 * [Polyglot](https://github.com/untra/polyglot)
-* [Jekyll Multiple Languages](https://github.com/liaohuqiu/jekyll-multiple-languages)
-* [Octopress Multilingual](https://github.com/octopress/multilingual)
-* [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags)
+* [Jekyll Language Plugin](https://github.com/vwochnik/jekyll-language-plugin)
 * [jekyll-task-i18n](https://github.com/ruby-gettext/jekyll-task-i18n)
 
 **Seems to be unmaintained / abandoned:**
-
+* [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags)
+* [Octopress Multilingual](https://github.com/octopress/multilingual)
+* [Jekyll Multiple Languages](https://github.com/liaohuqiu/jekyll-multiple-languages)
 * [Jekyll-Multilingualism](https://github.com/aleiphoenix/jekyll-multilingualism)
 * [Jekyll::Languages](https://github.com/janlindblom/jekyll-languages)
 * [Jekyll I18n support](https://github.com/hendricius/jekyll-i18n)

data/lib/jekyll-multiple-languages-plugin.rb

@@ -19,6 +19,51 @@ module Jekyll
   #*****************************************************************************
   # :site, :post_render hook
   #*****************************************************************************
+  Jekyll::Hooks.register :site, :pre_render do |site, payload|
+      lang = site.config['lang']
+      puts "Loading translation from file #{site.source}/_i18n/#{lang}.yml"
+      site.parsed_translations[lang] = YAML.load_file("#{site.source}/_i18n/#{lang}.yml")
+  end
+
+  #*****************************************************************************
+  # :site, :post_write hook
+  #*****************************************************************************
+  Jekyll::Hooks.register :site, :post_write do |site|
+
+    # Moves excluded paths from the default lang subfolder to the root folder
+    #===========================================================================
+    default_lang = site.config["default_lang"]
+    current_lang = site.config["lang"]
+    exclude_paths = site.config["exclude_from_localizations"]
+
+    if (default_lang == current_lang && site.config["default_locale_in_subfolder"])
+      files = Dir.glob(File.join("_site/" + current_lang + "/", "*"))
+      files.each do |file_path|
+        parts = file_path.split('/')
+        f_path = parts[2..-1].join('/')
+        if (f_path == 'base.html')
+          new_path = parts[0] + "/index.html"
+          puts "Moving '" + file_path + "' to '" + new_path + "'"
+          File.rename file_path, new_path
+        else
+          exclude_paths.each do |exclude_path|
+            if (exclude_path == f_path)
+              new_path = parts[0] + "/" + f_path
+              puts "Moving '" + file_path + "' to '" + new_path + "'"
+              if (Dir.exists?(new_path))
+                FileUtils.rm_r new_path
+              end
+              File.rename file_path, new_path
+            end
+          end
+        end
+      end
+    end
+
+    #===========================================================================
+
+  end
+
   Jekyll::Hooks.register :site, :post_render do |site, payload|
     
     # Removes all static files that should not be copied to translated sites.
@@ -29,17 +74,23 @@ module Jekyll
     static_files  = payload["site"]["static_files"]
     exclude_paths = payload["site"]["exclude_from_localizations"]
     
+    default_locale_in_subfolder = site.config["default_locale_in_subfolder"]
     
     if default_lang != current_lang
       static_files.delete_if do |static_file|
-          
+        next true if (static_file.name == 'base.html' && default_locale_in_subfolder)
+
         # Remove "/" from beginning of static file relative path
-        static_file_r_path    = static_file.instance_variable_get(:@relative_path).dup
-        static_file_r_path[0] = ''
-        
-        exclude_paths.any? do |exclude_path|
-          Pathname.new(static_file_r_path).descend do |static_file_path|
-            break(true) if (Pathname.new(exclude_path) <=> static_file_path) == 0
+        if static_file.instance_variable_get(:@relative_path) != nil
+          static_file_r_path = static_file.instance_variable_get(:@relative_path).dup
+          if static_file_r_path
+            static_file_r_path[0] = ''
+
+            exclude_paths.any? do |exclude_path|
+              Pathname.new(static_file_r_path).descend do |static_file_path|
+                break(true) if (Pathname.new(exclude_path) <=> static_file_path) == 0
+              end
+            end
           end
         end
       end
@@ -49,7 +100,17 @@ module Jekyll
     
   end
 
+  #*****************************************************************************
+  # :site, :pre_render hook
+  #*****************************************************************************
+  Jekyll::Hooks.register :site, :pre_render do |site, payload|
 
+    # Localize front matter data of every page.
+    #===========================================================================
+    (site.pages + site.documents).each do |item|
+      translate_props(item.data, site)
+     end
+  end
 
   ##############################################################################
   # class Site
@@ -72,6 +133,8 @@ module Jekyll
       self.parsed_translations ||= {}
       
       self.config['exclude_from_localizations'] ||= []
+
+      self.config['default_locale_in_subfolder'] ||= false
       
       if ( !self.config['languages']         or
             self.config['languages'].empty?  or
@@ -87,8 +150,8 @@ module Jekyll
       #-------------------------------------------------------------------------
       
       # Original Jekyll configurations
-      baseurl_org                 = self.config[ 'baseurl' ] # Baseurl set on _config.yml
-      dest_org                    = self.dest                # Destination folder where the website is generated
+      baseurl_org                 = self.config[ 'baseurl' ].to_s # Baseurl set on _config.yml
+      dest_org                    = self.dest                     # Destination folder where the website is generated
       
       # Site building only variables
       languages                   = self.config['languages'] # List of languages set on _config.yml
@@ -99,27 +162,24 @@ module Jekyll
       self.config['baseurl_root'] = baseurl_org              # Baseurl of website root (without the appended language code)
       self.config['translations'] = self.parsed_translations # Hash that stores parsed translations read from YAML files. Exposes this hash to Liquid.
       
-      
-      # Build the website for default language
-      #-------------------------------------------------------------------------
-      puts "Building site for default language: \"#{self.config['lang']}\" to: #{self.dest}"
-      
-      process_org
-      
-      
-      # Build the website for the other languages
+      # Build the website for all languages
       #-------------------------------------------------------------------------
       
       # Remove .htaccess file from included files, so it wont show up on translations folders.
       self.include -= [".htaccess"]
       
-      languages.drop(1).each do |lang|
+      languages.each do |lang|
         
         # Language specific config/variables
-        @dest                  = dest_org    + "/" + lang
-        self.config['baseurl'] = baseurl_org + "/" + lang
-        self.config['lang']    =                     lang
+        if lang != self.config['default_lang'] || self.config['default_locale_in_subfolder']
+          @dest                  = dest_org    + "/" + lang
+          self.config['baseurl'] = baseurl_org + "/" + lang
+          self.config['lang']    =                     lang
+        end
         
+        # Translate site attributes to current language
+        translate_props(self.config, self)
+
         puts "Building site for language: \"#{self.config['lang']}\" to: #{self.dest}"
         
         process_org
@@ -156,6 +216,26 @@ module Jekyll
 
 
 
+  ##############################################################################
+  # class PageReader
+  ##############################################################################
+  class PageReader
+    alias :read_org :read
+
+    #======================================
+    # read
+    #
+    # Monkey patched this method to remove excluded languages.
+    #======================================
+    def read(files)
+      read_org(files).reject do |page|
+        page.data['languages'] && !page.data['languages'].include?(site.config['lang'])
+      end
+    end
+  end
+
+
+
   ##############################################################################
   # class PostReader
   ##############################################################################
@@ -180,11 +260,14 @@ module Jekyll
   
   
   
-  ##############################################################################
-  # class Page
-  ##############################################################################
-  class Page
-  
+  #-----------------------------------------------------------------------------
+  #
+  # Include (with priority—prepend)the translated
+  # permanent link for Page and document
+  #
+  #-----------------------------------------------------------------------------
+
+  module Permalink
     #======================================
     # permalink
     #======================================
@@ -193,14 +276,18 @@ module Jekyll
       
       if site.config['relative_permalinks']
         File.join(@dir,  data['permalink'])
-      else
+      elsif site.config['lang']
         # Look if there's a permalink overwrite specified for this lang
-        data['permalink_'+site.config['lang']] || data['permalink']
+        data['permalink_' + site.config['lang']] || data['permalink']
+      else
+        data['permalink']
       end
       
     end
   end
 
+  Page.prepend(Permalink)
+  Document.prepend(Permalink)
 
 
   ##############################################################################
@@ -305,19 +392,18 @@ module Jekyll
       
       lang = site.config['lang']
       
-      unless site.parsed_translations.has_key?(lang)
-        puts              "Loading translation from file #{site.source}/_i18n/#{lang}.yml"
-        site.parsed_translations[lang] = YAML.load_file("#{site.source}/_i18n/#{lang}.yml")
-      end
-      
       translation = site.parsed_translations[lang].access(key) if key.is_a?(String)
       
       if translation.nil? or translation.empty?
          translation = site.parsed_translations[site.config['default_lang']].access(key)
         
-        puts "Missing i18n key: #{lang}:#{key}"
-        puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
+        if site.config["verbose"]
+          puts "Missing i18n key: #{lang}:#{key}"
+          puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
+        end
       end
+
+      TranslatedString.translate(key, lang, site)
       
       translation
     end
@@ -348,9 +434,24 @@ module Jekyll
         
         site = context.registers[:site] # Jekyll site object
         
-        includes_dir = File.join(site.source, '_i18n/' + site.config['lang'])
-        
+        default_lang = site.config['default_lang']
+
         validate_file_name(file)
+
+        includes_dir = File.join(site.source, '_i18n/' + site.config['lang'])
+
+        # If directory doesn't exist, go to default lang
+        if !Dir.exist?(includes_dir)
+          includes_dir = File.join(site.source, '_i18n/' + default_lang)
+        elsif
+          # If file doesn't exist, go to default lang
+          Dir.chdir(includes_dir) do
+            choices = Dir['**/*'].reject { |x| File.symlink?(x) }
+            if !choices.include?(  file)
+              includes_dir = File.join(site.source, '_i18n/' + default_lang)
+            end
+          end
+        end
         
         Dir.chdir(includes_dir) do
           choices = Dir['**/*'].reject { |x| File.symlink?(x) }
@@ -376,6 +477,25 @@ module Jekyll
         end
       end
     end
+
+    # Override of core Jekyll functionality, to get rid of deprecation
+    # warning. See https://github.com/jekyll/jekyll/pull/7117 for more
+    # details.
+    class PostComparer
+      def initialize(name)
+        @name = name
+
+        all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
+        unless all
+          raise Jekyll::Errors::InvalidPostNameError,
+                "'#{name}' does not contain valid date and/or title."
+        end
+
+        escaped_slug = Regexp.escape(slug)
+        @name_regex = %r!_posts/#{path}#{date}-#{escaped_slug}\.[^.]+|
+          ^#{path}_posts/?#{date}-#{escaped_slug}\.[^.]+!x
+      end
+    end
   end
 
 
@@ -420,10 +540,13 @@ module Jekyll
       pages        =           site.pages
       url          = "";
       
-      if default_lang != lang
+      if default_lang != lang || site.config['default_locale_in_subfolder']
         baseurl = baseurl + "/" + lang
       end
       
+      collections = site.collections.values.collect{|x| x.docs}.flatten
+      pages = site.pages + collections
+      
       for p in pages
         unless             p['namespace'].nil?
           page_namespace = p['namespace']
@@ -474,6 +597,86 @@ end
 
 
 
+#======================================
+# translate_key
+#
+# Translate given key to given language.
+#======================================
+def translate_key(key, lang, site)
+  unless site.parsed_translations.has_key?(lang)
+    puts              "Loading translation from file #{site.source}/_i18n/#{lang}.yml"
+    site.parsed_translations[lang] = YAML.load_file("#{site.source}/_i18n/#{lang}.yml")
+  end
+
+  translation = site.parsed_translations[lang].access(key) if key.is_a?(String)
+
+  if translation.nil? or translation.empty?
+    translation = site.parsed_translations[site.config['default_lang']].access(key)
+
+    puts "Missing i18n key: #{lang}:#{key}"
+    puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
+  end
+
+  translation
+end
+
+
+################################################################################
+# class TranslatedString
+################################################################################
+class TranslatedString < String
+  #======================================
+  # initialize
+  #======================================
+  def initialize(*several_variants, key)
+    super(*several_variants)
+    @key = key
+  end
+
+  def key
+    @key
+  end
+
+  #======================================
+  # translate
+  #======================================
+  def self.translate(str, lang, site)
+    if str.is_a?(TranslatedString)
+      key = str.key
+    else
+      key = str
+    end
+    return TranslatedString.new(translate_key(key, lang, site), key = key)
+  end
+end
+
+
+#======================================
+# translate_props
+#
+# Perform translation of properties defined in translation property list.
+#======================================
+def translate_props(data, site, props_key_name = 'translate_props')
+  lang = site.config['lang']
+  (data[props_key_name] || []).each do |prop_name|
+    if prop_name.is_a?(String)
+      prop_name = prop_name.strip
+      if prop_name.empty?
+        puts "There is an empty property defined in '#{props_key_name}'"
+      else
+        prop_value = data[prop_name]
+        if prop_value.is_a?(String) and !prop_value.empty?
+          data[prop_name] = TranslatedString.translate(prop_value, lang, site)
+        end
+      end
+    else
+      puts "Incorrect property name '#{prop_name}'. Must be a string"
+    end
+  end
+end
+
+
+
 ################################################################################
 # Liquid tags definitions
 
@@ -483,4 +686,3 @@ Liquid::Template.register_tag('tf',             Jekyll::Tags::LocalizeInclude)
 Liquid::Template.register_tag('translate_file', Jekyll::Tags::LocalizeInclude)
 Liquid::Template.register_tag('tl',             Jekyll::LocalizeLink         )
 Liquid::Template.register_tag('translate_link', Jekyll::LocalizeLink         )
-

data/lib/plugin/version.rb

@@ -1,6 +1,6 @@
 module Jekyll
   module MultipleLanguagesPlugin
-    VERSION = "1.5.1"
+    VERSION = "1.8.0"
   end
 end
 

metadata

@@ -1,43 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-multiple-languages-plugin
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Martin Kurtsson
-autorequire: 
+- Yonatan Miller
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: html-proofer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +48,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,12 +58,12 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 description: Plugin for Jekyll 2.x and 3.x that adds support for translated keys,
   templates and posts.
 email:
-- martin.kurtsson@screeninteraction.com
-- anthonygaudino45@gmail.com
+- martin.kurtsson@daresay.co
+- yonatan@shushugah.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -73,11 +74,11 @@ files:
 - README.md
 - lib/jekyll-multiple-languages-plugin.rb
 - lib/plugin/version.rb
-homepage: https://github.com/screeninteraction/jekyll-multiple-languages-plugin/
+homepage: https://github.com/kurtsson/jekyll-multiple-languages-plugin/
 licenses:
-- MPL2
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -93,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: I18n plugin for Jekyll
 test_files: []