#mdbook #fluent #variables #language #interpolation

bin+lib mdbook-fluent

使用 Fluent 语言进行变量插值的 mdBook 预处理器

1 个不稳定版本

0.1.0 2020年3月21日

#350 in 国际化 (i18n)

MIT/Apache

24KB
256

mdbook-fluent

mdBook 的一个简单 WIP 预处理器。它使用 mdBook。它使用 Fluent 语言 在您的书籍中插值变量。通过 fluent-rs Rust 实现 Fluent 项目。

免责声明
此预处理器不是设计用于翻译书籍!这是因为 mdBook 本身并非如此设计

入门

查看 ./examples/example 文件夹以获取一个工作示例。

安装

cargo install mdbook-fluent

book.toml

将以下内容添加到您的 book.toml

[preprocessor.fluent]

Fluent 文件

fluent 目录中创建扩展名为 .ftl 的文件,其中包含您的变量。每个文件的名称将用于将变量分组到逻辑块中。

您可以使用配置中的 dir 键更改包含您的 .ftl 文件的目录的名称。

示例 Fluent 文件

# fluent/example.ftl
Hello-world = Hello, world!
some-variable =
    .some-attribute = xd
multi-line =
    This is a multi-line Fluent value.
    The spaces before these lines will be automatically
    removed!

语法

在您的书籍中使用 {{#fluent FILE_NAME.TAG}}{{#fluent FILE_NAME.TAG.ATTRIBUTE 语法,如下所示

# Chapter 1

```
{{#fluent ch01.Hello-world}}
```

```rust,include
{{#include ../listing/example.rs}}
```

如上图所示,您可以将相同的 {{#fluent 标签放在将被包含的其他文件中。

构建

现在只需像平常一样构建您的书籍

mdbook build

贡献

欢迎任何形式的贡献,无论是问题、功能请求、pull请求还是问题。

许可证

MITAPACHE

依赖项

~17–29MB
~441K SLoC