#mdbook #localization #book

app mdbook-i18n

L10n/i18n 插件 for mdbook

4 个版本

0.1.3 2023年3月18日
0.1.2 2022年10月4日
0.1.1 2020年3月28日
0.1.0 2019年9月6日

#114国际化 (i18n)

MIT 许可证

18KB
168

mdBook-i18n

简单的 mdBook i18n 插件。

安装

需要 mdbook >= 0.3.1。

# cargo install mdbook
# cargo install mdbook-i18n

使用

  1. language 添加到您的 book.toml 文件中的 book 部分。
  2. output.i18n.translations 表添加到您的 book.toml 文件中。该表中每条记录必须包含 languagetitle。此外,记录还可以包含字段 authors(必须是数组)、translators(也必须是数组)、descriptionsrc。如果记录中不存在 src,则此字段将创建为 <book's root>/translations/<language name>
  3. 编写翻译。
  4. 运行 mdbook build 构建所有书籍。每本书都保存在目标目录中,文件夹名称为区域名称。

它是如何工作的?

从配置中转换源书籍到翻译配置。通用配置在所有翻译之间共享。之后,为每个翻译运行 mdbook

限制

  1. 主配置中的自定义值不会发送到 mdbook 配置。目前,该项目使用本机 RenderContext,它在 config 中有私有的 rest 字段(此字段包含来自配置的自定义值)。
  2. 书籍不共享资源。因为 mdbook 的原生渲染只能构建一个构建,每个构建都生成完整的资源树。
  3. 书籍没有不同 l10n 的链接。因为没有使用自定义模板的本机渲染。
  4. 也许我忘记了其他所有的事情。

许可证

MIT

依赖关系

~12–23MB
~329K SLoC