tldraw/guides/translation.md
with-heart 2e36dadfec
chore: clean up local dev tooling (#856)
* chore: clean up husky + lint-staged

* chore: format all files with prettier
2022-07-28 08:19:53 +01:00

1.4 KiB

Translation

Thanks for your interest in translating tldraw! This file has instructions for updating a translation or creating a new translation.

Update an Existing Translation

Want to update or correct an existing translations?

Create a new branch on Github.

Open the language file in packages/tldraw/src/translations

Make whichever changes you like.

Submit your branch as a PR on Github.

Add a New Translation

Want to add a new language to our translations?

Create a new branch on Github.

In the packages/tldraw/src/translations folder, duplicate the main.json file.

Rename the new file to the language code for that language. For example, if you were making an Esperanto translation, name the new file eo.json.

In the packages/tldraw/src/translations/translations.ts file, import your file and create a new entry in to the TRANSLATIONS array like this:

import en from './en.json'
import ar from './ar.json'
import eo from './eo.json' // <-- import here

export const TRANSLATIONS: TDTranslations = [
  // Default language:
  { code: 'en', label: 'English', messages: en },
  // Translations:
  { code: 'ar', label: 'عربي', messages: ar },
  { code: 'eo', label: 'Esperanto', messages: eo }, // <-- add an entry here
]

Translate the messages in the new file from English to your language.

That's it!

Submit your branch as a PR on Github.