Skip to content

Commit 113c48c

Browse files
docs: update Tools section (#1712)
1 parent 891d7df commit 113c48c

File tree

3 files changed

+13
-33
lines changed

3 files changed

+13
-33
lines changed

website/docs/tools/crowdin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ npm install @crowdin/cli@3
8282

8383
Add these lines to your `package.json` to make your life easier.
8484

85-
```js title="package.json"
85+
```json title="package.json"
8686
{
8787
"scripts": {
8888
"crowdin": "crowdin",

website/docs/tools/introduction.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -30,43 +30,21 @@ Instead of manually sending and receiving many emails and fixing the inconsisten
3030

3131
## Benefits of these tools
3232

33-
- **Synchronization**: unique `yarn sync` or `npm run sync` command to synchronize your project with all your translators and update your local `.po` and `.js` files with the latest translations.
34-
- **Translation Interface**: provide a professional and flexible interface to translators.
35-
- **Translation Memory**: assist translators by suggesting previously translated sentences that are similar.
36-
- **Machine Translation**: auto-translate with Google Translate, DeepL, etc. and human-proofread later.
37-
- **Smart Plural Management**: allows to translate `Message` and `Messages` instead of `{count, plural, one {Message} other {Messages}}`.
38-
- **Consistency**: assist translators with `{variable}` interpolation and HTML formatting.
39-
40-
## Configure your project
41-
42-
To synchronize your current application with an online tool, you just have to add these lines at the end of your `lingui.config.js` configuration file:
43-
44-
```js title="lingui.config.js"
45-
/** @type {import('@lingui/conf').LinguiConfig} */
46-
module.exports = {
47-
[...]
48-
service: {
49-
name: "ToolName",
50-
apiKey: "abcdefghijklmnopqrstuvwxyz012345"
51-
}
52-
}
53-
54-
```
55-
56-
The synchronization will then be part of the [`extract`](/docs/ref/cli.md#extract) command.
33+
- **Synchronization**: unique `yarn sync` or `npm run sync` command to synchronize your project with all your translators and update your local `.po` and `.js` files with the latest translations.
34+
- **Translation Interface**: provide a professional and flexible interface to translators.
35+
- **Translation Memory**: assist translators by suggesting previously translated sentences that are similar.
36+
- **Machine Translation**: auto-translate with Google Translate, DeepL, etc. and human-proofread later.
37+
- **Smart Plural Management**: allows to translate `Message` and `Messages` instead of `{count, plural, one {Message} other {Messages}}`.
38+
- **Consistency**: assist translators with `{variable}` interpolation and HTML formatting.
5739

5840
## List of available tools
5941

6042
### [Crowdin](https://crowdin.com/?utm_source=lingui.dev&utm_medium=referral&utm_campaign=lingui.dev)
6143

62-
- Documentation: [Crowdin](/docs/tools/crowdin.md)
63-
- GitHub: <https://github.com/crowdin>
44+
- Documentation: [Crowdin](/docs/tools/crowdin.md)
45+
- GitHub: <https://github.com/crowdin>
6446

6547
### [Translation.io](https://translation.io/lingui)
6648

67-
- Documentation: [translation-io](/docs/tools/translation-io.md)
68-
- GitHub: <https://github.com/translation/lingui>
69-
70-
## Adding a new tool to Lingui
71-
72-
If you want to integrate a new tool with Lingui, you have to add your synchronization workflow in a new file located in [this directory](https://github.com/lingui/js-lingui/tree/main/packages/cli/src/services) and then create a pull request on the main Lingui project.
49+
- Documentation: [translation-io](/docs/tools/translation-io.md)
50+
- GitHub: <https://github.com/translation/lingui>

website/docs/tools/translation-io.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ The configuration file looks like this:
110110
}
111111
```
112112

113+
The synchronization will then be part of the [`extract`](/docs/ref/cli.md#extract) command.
114+
113115
### 3. Add the following scripts
114116

115117
Add these lines to your `package.json` to make your life easier.

0 commit comments

Comments
 (0)