1- # Gettext Translation Support for ` mdbook `
1+ # Internationalization and Rendering extensions for ` mdbook `
22
33[ ![ Visit crates.io] ( https://img.shields.io/crates/v/mdbook-i18n-helpers?style=flat-square )] ( https://crates.io/crates/mdbook-i18n-helpers )
44[ ![ Build workflow] ( https://img.shields.io/github/actions/workflow/status/google/mdbook-i18n-helpers/test.yml?style=flat-square )] ( https://github.com/google/mdbook-i18n-helpers/actions/workflows/test.yml?query=branch%3Amain )
55[ ![ GitHub contributors] ( https://img.shields.io/github/contributors/google/mdbook-i18n-helpers?style=flat-square )] ( https://github.com/google/mdbook-i18n-helpers/graphs/contributors )
66[ ![ GitHub stars] ( https://img.shields.io/github/stars/google/mdbook-i18n-helpers?style=flat-square )] ( https://github.com/google/mdbook-i18n-helpers/stargazers )
77
8- The plugins here makes it easy to translate documentation written in
9- [ ` mdbook ` ] ( https://github.com/rust-lang/mdBook/ ) into multiple languages.
10- Support for translations is a
11- [ long-stading feature request for ` mdbook ` ] ( https://github.com/rust-lang/mdBook/issues/5 ) .
8+ This repository contains the following crates that provide extensions and
9+ infrastructure for [ mdbook] ( https://github.com/rust-lang/mdBook/ ) :
10+
11+ - [ mdbook-i18n-helpers] ( ./i18n-helpers/README.md ) : Gettext translation support
12+ for [ mdbook] ( https://github.com/rust-lang/mdBook/ )
1213
1314## Showcases
1415
15- Please add your project below if it uses this infrastructure for translations:
16+ ### mdbook-i18n-helpers
17+
18+ Please add your project below if it uses
19+ [ mdbook-i18n-helpers] ( i18n-helpers/README.md ) for translations:
1620
1721- [ Comprehensive Rust 🦀] ( https://google.github.io/comprehensive-rust/ )
1822- [ Game Boy Assembly Tutorial] ( https://gbdev.io/gb-asm-tutorial/ )
@@ -24,13 +28,16 @@ Please add your project below if it uses this infrastructure for translations:
2428
2529## Installation
2630
31+ ### ` mdbook-i18n-helpers `
32+
2733Run
2834
2935``` shell
3036$ cargo install mdbook-i18n-helpers
3137```
3238
33- Please see [ USAGE] ( USAGE.md ) for how to translate your ` mdbook ` project.
39+ Please see [ USAGE] ( ./i18n-helpers/USAGE.md ) for how to translate your
40+ [ mdbook] ( https://github.com/rust-lang/mdBook/ ) project.
3441
3542## Changelog
3643
0 commit comments