#mdbook #translation #gettext #localization

bin+lib mdbook-i18n-helpers

Plugins for a mdbook translation workflow based on Gettext

10 releases

new 0.3.3 May 27, 2024
0.3.2 Jan 15, 2024
0.3.0 Nov 9, 2023
0.2.4 Sep 27, 2023
0.1.0 Apr 4, 2023

#33 in Internationalization (i18n)

Download history 2191/week @ 2024-02-10 1977/week @ 2024-02-17 1571/week @ 2024-02-24 2950/week @ 2024-03-02 1706/week @ 2024-03-09 1755/week @ 2024-03-16 1080/week @ 2024-03-23 1025/week @ 2024-03-30 1658/week @ 2024-04-06 2091/week @ 2024-04-13 1237/week @ 2024-04-20 1255/week @ 2024-04-27 1413/week @ 2024-05-04 978/week @ 2024-05-11 1317/week @ 2024-05-18 1531/week @ 2024-05-25

5,691 downloads per month

Apache-2.0

140KB
3K SLoC

Gettext Translation Support for mdbook

Visit crates.io Build workflow GitHub contributors GitHub stars

The plugins here makes it easy to translate documentation written in mdbook into multiple languages. Support for translations is a long-stading feature request for mdbook.

Installation

Run

$ cargo install mdbook-i18n-helpers

Please see USAGE for how to translate your mdbook project.

Configuration

You can customize the plugins in your book.toml file.

mdbook-xgettext

  • output.xgettext.pot-file (no default, required): Set this to the path of your POT file. A typical value is messages.pot, see examples in USAGE.
  • output.xgettext.granularity (default: 1): Set this to n to round all line numbers down to the nearest multiple of n. Set this to 0 to remove line numbers completely from the PO file. This can help reduce churn in your PO files when messages edited.

Changelog

Please see the CHANGELOG for details on the major changes in each release.

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.

Dependencies

~13–24MB
~332K SLoC