https://github.com/google/mdbook-i18n-helpers
Translation support for mdbook. The plugins here give you a structured way to maintain a translated book.
https://github.com/google/mdbook-i18n-helpers
gettext i18n l10n mdbook mdbook-preprocessor mdbook-renderer rust
Last synced: about 1 month ago
JSON representation
Translation support for mdbook. The plugins here give you a structured way to maintain a translated book.
- Host: GitHub
- URL: https://github.com/google/mdbook-i18n-helpers
- Owner: google
- License: apache-2.0
- Created: 2023-03-21T15:57:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T17:29:58.000Z (about 1 month ago)
- Last Synced: 2025-05-13T12:05:40.200Z (about 1 month ago)
- Topics: gettext, i18n, l10n, mdbook, mdbook-preprocessor, mdbook-renderer, rust
- Language: Rust
- Homepage:
- Size: 444 KB
- Stars: 172
- Watchers: 7
- Forks: 33
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - google/mdbook-i18n-helpers - Translation support for mdbook. The plugins here give you a structured way to maintain a translated book. (rust)
README
# Internationalization and Rendering extensions for `mdbook`
[](https://crates.io/crates/mdbook-i18n-helpers)
[](https://github.com/google/mdbook-i18n-helpers/actions/workflows/test.yml?query=branch%3Amain)
[](https://github.com/google/mdbook-i18n-helpers/graphs/contributors)
[](https://github.com/google/mdbook-i18n-helpers/stargazers)
This repository contains the following crates that provide extensions and
infrastructure for [mdbook](https://github.com/rust-lang/mdBook/):
- [mdbook-i18n-helpers](./i18n-helpers/README.md): Gettext translation support
for [mdbook](https://github.com/rust-lang/mdBook/)
- [mdbook-tera-backend](./mdbook-tera-backend/README.md): Tera templates
extension for [mdbook](https://github.com/rust-lang/mdBook/)'s HTML renderer.
- [i18n-report](i18n-report/README.md): A tool to generate an HTML report
comparing the status of a number of translations.
## Showcases
### mdbook-i18n-helpers
Please add your project below if it uses
[mdbook-i18n-helpers](i18n-helpers/README.md) for translations:
- [Comprehensive Rust 🦀](https://google.github.io/comprehensive-rust/)
- [Game Boy Assembly Tutorial](https://gbdev.io/gb-asm-tutorial/)
- [Ordinal Theory Handbook](https://docs.ordinals.com/)
- [Getting Started with SONiC](https://r12f.com/sonic-book/)
- [Dojo: The Provable Game Engine](https://book.dojoengine.org/)
- [ezlog documentation](https://s1rius.github.io/ezlog/)
- [The Cairo Programming Language](https://book.cairo-lang.org/)
- [The Veryl Hardware Description Language](https://doc.veryl-lang.org/book/)
- [Rust By Example](https://github.com/rust-lang/rust-by-example)
### i18n-report
- [Comprehensive Rust 🦀](https://google.github.io/comprehensive-rust/translation-report.html)
## Installation
### `mdbook-i18n-helpers`
Run
```shell
cargo install mdbook-i18n-helpers
```
Please see [USAGE](i18n-helpers/USAGE.md) for how to translate your
[mdbook](https://github.com/rust-lang/mdBook/) project.
Please see the [i18n-helpers/CHANGELOG](CHANGELOG) for details on the changes in
each release.
### `mdbook-tera-backend`
Run
```shell
cargo install mdbook-tera-backend
```
### `i18n-report`
Run
```shell
cargo install i18n-report
```
## Contact
For questions or comments, please contact
[Martin Geisler](mailto:[email protected]) or start a
[discussion](https://github.com/google/mdbook-i18n-helpers/discussions). We
would love to hear from you.
---
This is not an officially supported Google product.