README.md

Internationalization and Rendering extensions for mdbook

This repository contains the following crates that provide extensions and infrastructure for mdbook:

• mdbook-i18n-helpers: Gettext translation support for mdbook
• mdbook-tera-backend: Tera templates extension for mdbook's HTML renderer.
• i18n-report: 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 for translations:

• Comprehensive Rust 🦀
• Game Boy Assembly Tutorial
• Ordinal Theory Handbook
• Getting Started with SONiC
• Dojo: The Provable Game Engine
• ezlog documentation
• The Cairo Programming Language
• The Veryl Hardware Description Language
• Rust By Example

i18n-report

• Comprehensive Rust 🦀

Installation

mdbook-i18n-helpers

Run

cargo install mdbook-i18n-helpers

Please see USAGE for how to translate your mdbook project.

Please see the i18n-helpers/CHANGELOG for details on the changes in each release.

mdbook-tera-backend

Run

$ cargo install mdbook-tera-backend

i18n-report

Run

$ cargo install i18n-report

Contact

For questions or comments, please contact Martin Geisler or start a discussion. We would love to hear from you.

---

This is not an officially supported Google product.