https://github.com/JakubKoralewski/mdbook-fluent

mdBook preprocessor for variable interpolation using the Fluent language
https://github.com/JakubKoralewski/mdbook-fluent

fluent mdbook mdbook-plugins

Last synced: 17 days ago
JSON representation

mdBook preprocessor for variable interpolation using the Fluent language

• Host: GitHub
• URL: https://github.com/JakubKoralewski/mdbook-fluent
• Owner: JakubKoralewski
• License: mit
• Created: 2020-03-21T17:50:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-03-22T09:34:50.000Z (over 4 years ago)
• Last Synced: 2024-10-28T22:57:33.682Z (about 2 months ago)
• Topics: fluent, mdbook, mdbook-plugins
• Language: Rust
• Size: 16.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - JakubKoralewski/mdbook-fluent - mdBook preprocessor for variable interpolation using the Fluent language (others)

README

        
# mdbook-fluent

[![Build Status](https://github.com/JakubKoralewski/mdbook-fluent/workflows/CI/badge.svg)](https://github.com/JakubKoralewski/mdbook-fluent/actions?workflow=CI)

[![crates.io](https://img.shields.io/crates/v/mdbook-fluent.svg)](https://crates.io/crates/mdbook-fluent)

[![Crates.io](https://img.shields.io/crates/l/mdbook-fluent)](./LICENSE)

A simple WIP preprocessor for [mdBook](https://github.com/rust-lang/mdBook).

It uses the [Fluent language](https://projectfluent.org/) to interpolate

variables inside your book. 

Building on the shoulders of giants via

the [fluent-rs](https://github.com/projectfluent/fluent-rs) Rust implementation

of the Fluent Project.

**DISCLAIMER:**  

This preprocessor is not currently designed to be used to translate 

books! This is because [mdBook itself is not designed this way](https://github.com/rust-lang/mdBook/issues/146#issuecomment-354759316)!

## Getting started

Check out the [./examples/example](./examples/example) folder for

a working example.

### Install

```bash

cargo install mdbook-fluent

```

### book.toml

Add this to your `book.toml`:

```toml

[preprocessor.fluent]

```

### Fluent files

In the `fluent` directory create files with the `.ftl`

extension containing your variables. The name of each file

will be used to group the variables into logical chunks. 

You can use the `dir` key in the config to change the name of the directory containing

your `.ftl` files.

Example Fluent File:

```ftl

# 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!

```

### Syntax:

In your books use the `{{#fluent FILE_NAME.TAG}}`

or `{{#fluent FILE_NAME.TAG.ATTRIBUTE}}` syntax, like so:

    # Chapter 1

    ```

    {{#fluent ch01.Hello-world}}

    ```

    ```rust,include

    {{#include ../listing/example.rs}}

    ```

As you can see above, you can put the same `{{#fluent ...}}` tags

inside other files that will be included using the built-in `links` preprocessor.

### Build

Now simply build your book like you would normally:

```bash

mdbook build

```

## Contributions

I welcome any contributions, whether they would be issues,

feature requests, pull requests or questions.

## License

[MIT](./LICENSE) or [APACHE](LICENSE-APACHE)