Skip to content

Commit

Permalink
Merge branch 'skip' of https://github.com/dyoo/mdbook-i18n-helpers in…
Browse files Browse the repository at this point in the history
…to skip
  • Loading branch information
dyoo committed Sep 4, 2023
2 parents 8225010 + e9765df commit f51e090
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ to install three binaries:
- `mdbook-i18n-normalize`: This program normalizs a PO file. Use it after
breaking changes.

[`mdbook` renderer]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html
[`mdbook` preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html

Together, the two programs makes it possible to do i18n for `mdbook` in a
standard and maintainable way.

Expand Down Expand Up @@ -55,9 +52,6 @@ their target language.
We will show how to update and manipulate the `.po` and `.pot` files using the
GNU Gettext utilities below.

[Gettext]: https://www.gnu.org/software/gettext/manual/html_node/index.html
[ISO 639]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

### Marking sections to be skipped for translation

A block can be marked to be skipped for translation by prepending a special
Expand Down Expand Up @@ -204,8 +198,6 @@ extra-watch-dirs = ["po"]

Please see the [`publish.yml`] workflow in the Comprehensive Rust 🦀 repository.

[`publish.yml`]: https://github.com/google/comprehensive-rust/blob/main/.github/workflows/publish.yml

## Normalizing Existing PO Files

When mdbook-i18n-helpers change, the generated PO files change as well. This can
Expand Down Expand Up @@ -266,3 +258,9 @@ msgstr "BAR"

You will only need to run `mdbook-i18n-normalize` once after upgrading
mdbook-i18n-helpers.

[gettext]: https://www.gnu.org/software/gettext/manual/html_node/index.html
[iso 639]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
[`mdbook` preprocessor]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html
[`mdbook` renderer]: https://rust-lang.github.io/mdBook/format/configuration/renderers.html
[`publish.yml`]: https://github.com/google/comprehensive-rust/blob/main/.github/workflows/publish.yml

0 comments on commit f51e090

Please sign in to comment.