Skip to content

Commit

Permalink
Duplicate README.md for workspace architecture (#89)
Browse files Browse the repository at this point in the history
Duplicate README.md for workspace architecture

---------

Co-authored-by: Martin Geisler <mgeisler@google.com>
  • Loading branch information
sakex and mgeisler authored Sep 25, 2023
1 parent 021f1bf commit d75fc18
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# Gettext Translation Support for `mdbook`
# Internationalization and Rendering extensions for `mdbook`

[![Visit crates.io](https://img.shields.io/crates/v/mdbook-i18n-helpers?style=flat-square)](https://crates.io/crates/mdbook-i18n-helpers)
[![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)
[![GitHub contributors](https://img.shields.io/github/contributors/google/mdbook-i18n-helpers?style=flat-square)](https://github.com/google/mdbook-i18n-helpers/graphs/contributors)
[![GitHub stars](https://img.shields.io/github/stars/google/mdbook-i18n-helpers?style=flat-square)](https://github.com/google/mdbook-i18n-helpers/stargazers)

The plugins here makes it easy to translate documentation written in
[`mdbook`](https://github.com/rust-lang/mdBook/) into multiple languages.
Support for translations is a
[long-stading feature request for `mdbook`](https://github.com/rust-lang/mdBook/issues/5).
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/)

## Showcases

Please add your project below if it uses this infrastructure for translations:
### 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/)
Expand All @@ -24,13 +28,16 @@ Please add your project below if it uses this infrastructure for translations:

## Installation

### `mdbook-i18n-helpers`

Run

```shell
$ cargo install mdbook-i18n-helpers
```

Please see [USAGE](USAGE.md) for how to translate your `mdbook` project.
Please see [USAGE](./i18n-helpers/USAGE.md) for how to translate your
[mdbook](https://github.com/rust-lang/mdBook/) project.

## Changelog

Expand Down
37 changes: 37 additions & 0 deletions i18n-helpers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Gettext Translation Support for `mdbook`

[![Visit crates.io](https://img.shields.io/crates/v/mdbook-i18n-helpers?style=flat-square)](https://crates.io/crates/mdbook-i18n-helpers)
[![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)
[![GitHub contributors](https://img.shields.io/github/contributors/google/mdbook-i18n-helpers?style=flat-square)](https://github.com/google/mdbook-i18n-helpers/graphs/contributors)
[![GitHub stars](https://img.shields.io/github/stars/google/mdbook-i18n-helpers?style=flat-square)](https://github.com/google/mdbook-i18n-helpers/stargazers)

The plugins here makes it easy to translate documentation written in
[`mdbook`](https://github.com/rust-lang/mdBook/) into multiple languages.
Support for translations is a
[long-stading feature request for `mdbook`](https://github.com/rust-lang/mdBook/issues/5).

## Installation

Run

```shell
$ cargo install mdbook-i18n-helpers
```

Please see [USAGE](USAGE.md) for how to translate your `mdbook` project.

## Changelog

Please see [CHANGELOG](../CHANGELOG.md) for details on the changes in each
release.

## Contact

For questions or comments, please contact
[Martin Geisler](mailto:mgeisler@google.com) 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.
File renamed without changes.

0 comments on commit d75fc18

Please sign in to comment.