PageForge 支持用户自定义的国际化设置,需要启用后才能使用国际化。
启用国际化后,需要配置国际化语言
在
只需要将
启用国际化
yaml
i18n:
enable: true
yaml
i18n:
default: zh-CN
en:
name: English
flag: 🇬🇧
translations:
GetStarted: Getting Started
Setup: Setup
Usage: Usage Docs
zh-CN:
name: 中文
flag: 🇨🇳
translations:
GetStarted: 快速开始
Setup: 设置
Usage: 使用文档
-
default
: 默认语言 -
en
、zh-CN
: 自定义语言 -
translations
: 对应语言的翻译,格式为key: value
pageforge.yaml
中配置的语言来自动加载对应的翻译,如果没有找到翻译,则会返回原 key
使用国际化
在
pageforge.yaml
中配置国际化后,可以在
nav
中使用以下方式来获取翻译的结果。
yaml
nav:
- GetStarted:
- /getting-started/get-started
-
GetStarted
: 要翻译的 key,如果没有找到翻译,则会返回原 key
yaml
---
title: GetStarted
icon: crosshair
---
title
中替换为国际化的 key 就可以了
国际化的文档名格式为
file.lang.md
,比如我们的
index.md
如果要配置国际化文件名,可以这样写
index.en.md
贡献者