You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,9 @@ That's where Replexica comes in: it's a build system plugin (+ AI engine in the
16
16
17
17
## API
18
18
19
+
> [!NOTE]
20
+
> This guide is for Next.js App Router apps only. Support for other setups is coming soon (ETA April 2024).
21
+
19
22
```js
20
23
// next.config.mjs
21
24
@@ -43,32 +46,29 @@ export default compiler.next(
43
46
44
47
The Replexica compiler is open-source, and the platform API is open, allowing you to build your own translation engine.
45
48
46
-
We're also developing our own AI translation platform ([replexica.com](https://replexica.com)), to make it even easier to launch your first multi-language app!
49
+
We're also developing our own i18n engine called [Replexica Cloud](https://replexica.com), to make it even easier to ship your first multi-language app!
47
50
48
51
-[x] Replexica Compiler
49
52
-[x] Next.js App Router
50
53
-[ ] Next.js Pages Router (April 2024)
51
54
-[ ] Remix (May 2024)
52
55
-[ ] Create React App (May 2024)
53
56
-[x] Replexica Framework
54
-
-[x] JSX translation
57
+
-[x]Core JSX translation
55
58
-[x] Custom context hints
56
-
-[x] Skipper for non-translatable text
57
-
-[x] Avoid fetching unused translations
58
59
-[x] Translation of JSX attributes (title, alt, placeholder)
59
60
-[ ] Translation of generic literals with helper functions
-[ ] (Create a GitHub issue to request a new language!)
71
-
-[ ]Automated i18n quality checks (May 2024)
71
+
-[ ]Quality checks (May 2024)
72
72
-[ ] Documentation/examples on self-hosted translation engine
73
73
-[x] Replexica CLI
74
74
-[x] CLI for Replexica Platform
@@ -80,7 +80,7 @@ We're also developing our own AI translation platform ([replexica.com](https://r
80
80
Replexica is a compiler plugin that integrates with the build system, collecting all user-facing text in the app and preparing it for translation with the Replexica platform. Here's how it works:
81
81
82
82
1.**Infers** metadata from your app, such as the text that needs to be translated and its context. This metadata is then stored alongside the build artifacts.
83
-
1.**Translates** the text using the CLI that connects to the Replexica platform. The platform uses AI to translate the text, and the more you use it, the better it gets. The API is open, so you can build your own translation engine if you wish!
83
+
1.**Translates** the text using the CLI that connects to the Replexica Cloud. The cloud engine uses AI to translate the text, and the more you use it, the better it gets. The API is open, so you can build your own translation engine if you wish!
84
84
1.**Injects** the translations back into your app, so that the translated text is displayed to the user, based on their locale.
85
85
86
86
With Replexica, you can build multi-language apps without the hassle of managing JSON files, and with the power of AI translation.
@@ -233,7 +233,7 @@ pnpm run start
233
233
> `pnpm replexica i18n` must be run after every build, to fetch the latest translations from the Replexica platform. It must be run in CI/CD pipelines as well, right after the `build` step.
234
234
235
235
> [!NOTE]
236
-
> We know that running `pnpm replexica i18n` after every build and running the build twice can be a bit cumbersome. We're working on a solution to make this process more streamlined!
236
+
> We know that running `pnpm replexica i18n` after every build and running the build twice can be a bit cumbersome. We're working on a solution to make this process more streamlined (ETA April 2024 🙏)!
237
237
238
238
### Step 5 (Optional). Test the result
239
239
@@ -274,4 +274,4 @@ So, whatever approach you choose for switching between locales, just be sure to
274
274
275
275
If you have any questions, feel free to create a GitHub issue!
0 commit comments