Jekyll多语言插件(Jekyll Multiple Languages Plugin)安装及使用指南

Jekyll多语言插件(Jekyll Multiple Languages Plugin)安装及使用指南

jekyll-multiple-languages-pluginI18n support for Jekyll and Octopress项目地址:https://gitcode.com/gh_mirrors/je/jekyll-multiple-languages-plugin

项目介绍

Jekyll Multiple Languages Plugin 是一个用于Jekyll网站的国际化插件,使您的Jekyll站点能够支持多种语言版本.它的工作方式类似于Rails中的多语言处理方法,可以编译出不同语言的页面并存储在相应的子目录下.

该插件由Daresay公司创建并维护,提供了以下主要功能:

• 支持翻译后的字符串以YAML格式保存;
• 支持模板文件的翻译;
• 能够处理翻译后的链接;

此外,该项目正在寻找更多的维护者以便进行更广泛的社区参与。

项目快速启动

安装步骤

使用gem安装

为了安装这个插件,您首先需要确保Ruby环境以及Jekyll已正确设置好. 接下来,您可以将此gem添加到应用程序的Gemfile中:

gem 'jekyll-multiple-languages-plugin'

然后执行以下命令来完成gem的安装:

$ bundle install

或者自行手动安装:

$ gem install jekyll-multiple-languages-plugin

最后,为了激活这个插件,您需要将其添加至Jekyll _config.yml 文件中的 plugins 配置项内:

plugins:
- jekyll-multiple-languages-plugin

更多配置详情可参考 Jekyll官方配置文档。

手动安装

如需手动安装,则从Git仓库下载或用其他方式获取源码。 在Jekyll的_plugins目录下新建名为jekyll-multiple-languages-plugin 的文件夹, 并将插件文件夹内的所有内容复制或链接至此处即可。

使用git submodule管理插件

如果您使用git管理Jekyll项目,可以通过添加git submodule的方式轻松管理插件:

$ git submodule add https://github.com/kurtsson/jekyll-multiple-languages-plugin.git _plugins/multiple-languages

更新submodule时执行:

$ cd _plugins/multiple-languages
$ git pull origin master

配置_yconfig.yml_

要启动多语言功能,请将可用的语言代码添加至_config.yml中(必填):

languages:
- sv #瑞典语
- en #英语
- de #德语
- fr #法语

列表中的第一个元素将是默认语言,其他语言会被分别存放在对应的子目录里,以避免重复。

应用示例

假设我们已经进行了上述的配置和安装操作,现在来看一些基本的应用场景。

翻译字符串

在Jekyll中,我们可以用特定的语法标记需要翻译的内容:

{{ "welcome_message" | t }}

这里的t过滤器告诉插件去查找这个键值对的翻译。

包含翻译后的文件

假如某个页面依赖于某个语言特定的资源文件,可以在页面源码中通过标签包含它们:

{% include path/to/specific/file.html %}

在该文件路径前加上适当的前缀以指定其所属的语言。

模板中的i18n支持

可以在布局或页眉脚等模版文件中使用类似的过滤器和标签来插入多语言内容。

<h1>{{ "title" | t }}</h1>

语言之间的链接

可以通过特殊函数生成指向其他语言版本页面的链接:

<a href="{{ "current_page_path" | url_for: lang='en' }}">English Version</a>

创建页面和帖子

创建新页面或发布新文章时,请在Front Matter部分指明其对应的language属性。

例如:

---
layout: post
title: My New Article
lang: zh-CN
---

这会使页面被自动归入正确的语言分区。

控制翻译范围

借助白名单和黑名单,开发人员可以选择性地跳过某些页面或板块的翻译工作。

比如:

exclude_translation:
- /footer.html
include_translation:
- /about/

以上指令指示了排除footer.html文件及仅翻译about子目录下的内容。

典型生态项目

下面列举了一些同类型插件的例子,可以作为参考或借鉴:

• Polyglot: 科技维护良好的另一款Jekyll多语言插件;
• Jekyll Language Plugin: 一款兼容Jekyll 3+的多语言支持插件;
• Octopress Multilingual: 专为Octopress主题设计的本地化工具。

结论

综上所述,Jekyll Multiple Languages Plugin提供了一套便捷的方式来实现Jekyll站点的多语言化。不仅简化了多语言内容的管理流程,而且提高了用户体验。建议开发者们根据自身需求选用适合自己的方案来增强站点的多语言能力。

---

本文档详细介绍了如何使用Jekyll Multiple Languages Plugin为你的Jekyll博客或其他静态网站添加多语言支持的过程。希望这份指南可以帮助你顺利启用和定制多语言功能,从而提升你网站的国际受众覆盖范围。如果你有任何疑问或建议,欢迎随时提出。

jekyll-multiple-languages-pluginI18n support for Jekyll and Octopress项目地址:https://gitcode.com/gh_mirrors/je/jekyll-multiple-languages-plugin