Eleventy 国际化插件使用教程
项目介绍
Eleventy 是一个静态站点生成器,而 eleventy-plugin-i18n
是一个用于辅助国际化的插件。该插件提供了上下文感知的国际化过滤器,支持智能字符串插值,使得在多语言环境中构建网站变得更加容易。
项目快速启动
安装插件
首先,你需要在你的 Eleventy 项目中安装 eleventy-plugin-i18n
插件:
npm install eleventy-plugin-i18n --save
配置插件
在你的 Eleventy 配置文件(通常是 .eleventy.js
)中引入并使用该插件:
const i18n = require('eleventy-plugin-i18n');
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(i18n, {
translations: {
hello: {
'en-GB': 'Hello',
'es-ES': 'Hola'
}
},
fallbackLocales: {
'*': 'en-GB'
}
});
};
创建语言目录
在项目根目录下为每种语言创建目录,例如 en-GB
和 es-ES
:
├─ src
│ └─ en-GB
│ ├─ about.njk
│ └─ index.njk
│ └─ es-ES
│ ├─ about.njk
│ └─ index.njk
使用国际化过滤器
在你的模板文件中使用国际化过滤器:
<!-- src/en-GB/index.njk -->
<html lang="en-GB">
<body>
<p>{{ 'hello' | i18n }}</p>
</body>
</html>
<!-- src/es-ES/index.njk -->
<html lang="es-ES">
<body>
<p>{{ 'hello' | i18n }}</p>
</body>
</html>
应用案例和最佳实践
多语言支持
使用 eleventy-plugin-i18n
插件可以轻松实现多语言支持。通过定义不同的语言目录和翻译文件,可以确保每个页面根据用户的语言偏好显示正确的翻译内容。
智能字符串插值
插件支持智能字符串插值,这意味着你可以在翻译字符串中嵌入动态内容,例如:
{{ 'welcome' | i18n({ name: 'John' }) }}
在翻译文件中定义:
{
"welcome": "Welcome, {name}!"
}
错误处理
如果某个翻译键在当前语言中找不到,插件会使用 fallbackLocales
中定义的默认语言进行回退,并在控制台中发出警告,帮助你及时发现并修复问题。
典型生态项目
Eleventy 社区
Eleventy 拥有一个活跃的社区,提供了许多插件和工具来增强其功能。除了 eleventy-plugin-i18n
之外,还有其他插件如 eleventy-plugin-seo
用于优化搜索引擎排名,eleventy-plugin-sass
用于集成 Sass 预处理器等。
相关资源
通过这些资源,你可以进一步扩展和优化你的 Eleventy 项目,实现更多复杂的功能和更好的用户体验。