Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yfxie/jekyll_i18n_multi_page
https://github.com/yfxie/jekyll_i18n_multi_page
i18n jekyll jekyll-plugin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/yfxie/jekyll_i18n_multi_page
- Owner: yfxie
- License: mit
- Created: 2019-08-22T10:40:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T06:17:24.000Z (almost 2 years ago)
- Last Synced: 2024-04-25T17:44:08.183Z (8 months ago)
- Topics: i18n, jekyll, jekyll-plugin
- Language: Ruby
- Size: 29.3 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Jekyll I18n MultiPage
[](https://codeclimate.com/github/yfxie/jekyll_i18n_multi_page/maintainability)
[](https://codeclimate.com/github/yfxie/jekyll_i18n_multi_page/test_coverage)
[](https://travis-ci.org/yfxie/jekyll_i18n_multi_page)
[](https://badge.fury.io/rb/jekyll_i18n_multi_page)
Generate multiple pages for different locales based on single template.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jekyll_i18n_multi_page'
```
And then execute:
$ bundle
Add the plugin to `_config.yml` file:
```yml
plugins:
- jekyll_i18n_multi_page
```
## Usage
Declare available locales in Jekyll config `_config.yml`:
```yml
i18n:
- path: /
locale: en
- path: /tw
locale: zh-TW
```
For each entry must contain `path`(the output of localized page) and `locale`.
Define files with localized contents in `_i18n` folder, filenames aren't mattered. For examples:
```yml
# _i18n/my-en-site.yml
en:
index:
title: English title
hello: Hello
```
```yml
# _i18n/my-tw-site.yml
zh-TW:
index:
title: 中文標題
hello: 哈囉
```
`page.i18n` is the way to access the current localized contents, said you have a HTML named `index.html`:
```html
---
---
{{ page.i18n.title }}
{{ page.i18n.hello }}
```
After building, the dist folder should have two files `index.html` and `tw/index.html`.
Assume you have a file named `some/where/my.html` you should have its path in the localization file:
```yml
# _i18n/my-en-site.yml
en:
some:
where:
my:
hello: Hello # access this text via page.i18n.hello
```
## Use cases
**For some reason, I have a page which is only available for certain locales**
```html
---
i18n_locales: ['zh-TW']
---
{{ page.i18n.hello }}
```
Using `i18n_locales` to declare the supported locales. In this example, Jekyll will build `tw/index.html` file only.
**How to disable the features on certain pages**
```html
---
i18n_disabled: true
---
```
Using `i18n_disabled` to tell the plugin do not do anything for me.
**Show/Hide something for certain locales**
```html
---
---
{% if page.i18n_locale == 'en' %}
You will see me only in the en page.
{% end %}
```
**Translate helper**
```
{% t index.hello %}
```
`t` tag provides a way to translate content. When you take this way, you must write a full path.
**i18n global variable**
`i18n` is a global variable provides you a way to access the root of localization.
```
---
i18n_disabled: true
i18n_locale: zh-TW
---
{{ i18n.some.page.title }}
{% for item in i18n.some.array %}
...
{% endfor %}
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/yfxie/jekyll_i18n_multi_page.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).