Docusaurus Translations

[anaclumos]

Problem

Would it be possible to use Inlang for Docusaurus? Docusaurus has two parts for translations. Inside i18n/{locale} folder,

• documents translations (md)
• UI translations (json)

Example:

{locale}
├── code.json
├── docusaurus-plugin-content-blog
│   └── options.json
├── docusaurus-plugin-content-docs
│   ├── current
│   │   └── 2023
│   │       ├── 07
│   │       │   ├── 28.md
│   │       │   ├── 29.md
│   │       │   ├── 30.md
│   │       │   └── 31.md
│   │       └── 08
│   │           └── 01.md
│   └── current.json
└── docusaurus-theme-classic
    ├── footer.json
    └── navbar.json

Proposal

I think translating json would be pretty doable with Inlang. Is there a way to include many json files as translation files like the above? (footer.json, current.json, etc.) Markdown, on the other hand, would be more complex. But I would like to hear from the Inlang team as well.

[samuelstroschein]

Hi @anaclumos,

1. Yes, you should be able to use inlang messages for the UI translations.
2. Markdown support is in the feature request box Document (markdown) support #402. Please upvote it! :)

Is there a way to include many json files as translation files like the above? (footer.json, current.json, etc.) Markdown, on the other hand, would be more complex. But I would like to hear from the Inlang team as well.

Yes, multiple json files are possible. @inlang/plugins can you share the solution that is currently impemented/you are currently discussing?

---

Off topic, for which docusaurus page would you like to use inlang?

[anaclumos]

Actually I can do it myself!

anaclumos/signalkite#43

[anaclumos]

Actually, now the docusaurus website fails to compile (pnpm run build), and I am on a fix right now.

[anaclumos]

So the problem is that docusaurus wants the key to be a string and does not represent a nested object. So we must retain something like theme.ErrorPageContent.title. So, reverting back to this will cause inlang to cause

Error: The inlang.config.js is invalid.

# The following errors occurred during the setup of plugins: None ✅
# The following errors occurred during the validation of the config: A roundtrip test of the readResources and writeResources functions failed:

The message with id "code:theme.NotFound.title.message" does not match for the resource with languageTag.name "ar".
Received: { "type": "Message", "id": { "type": "Identifier", "name": "code:theme.ErrorPageContent.tryAgain.message" }, "pattern": { "type": "Pattern", "elements": [ { "type": "Text", "value": "المحاولة مجددا" } ] } }
Expected: { "type": "Message", "id": { "type": "Identifier", "name": "code:theme.NotFound.title.message" }, "pattern": { "type": "Pattern", "elements": [ { "type": "Text", "value": "الصفحة غير موجودة" } ] } }
--- If plugins return errors, chances are high that the plugin errors are the root cause for the config errors. Try to fix the plugin errors first.

Any ideas?

[NiklasBuchfink]

I see what's the problem. inlang detects either nested or flattened keys for the whole file.

In the past, we have recognized the nesting per message and stored the metadata for it, but as soon as a new message is to be added, we do not know which formatting to apply.

Sadly it doesn't work at the moment. I only see two solutions:

1. Docusaurus has settings to fix it
2. It needs a custom inlang plugin for Docusaurus (https://inlang.com/documentation/plugins/custom-plugins)

Since we are refactoring, I don't recommend starting the plugin's development now.

[anaclumos]

Understood. Thank you so much for the help and support.