Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.51 KB

README.md

File metadata and controls

65 lines (44 loc) · 2.51 KB

Translate Obsidian

Help translate Obsidian into your language.

Request a language

If the language you want to translate doesn't exist as a JSON file yet, submit an issue so that we can create a template for you to get started.

Staying up-to-date

Merge conflicts are nasty. They happen when you're translating an outdated version of the template, part of which might have been translated by someone else. To prevent this, try to fork our respository right before you translate.

If you want to do multiple translation pull requests, before doing work each time, use the "Compare" UI on your own fork to pull in all the newest changes from obsidianmd:master first by creating a pull request on your own repository and merge it in yourself, so that your own copy is up-to-update.

Submit changes

To translate, fork this repo and edit the JSON file of your language. After that, submit a pull request.

Note that you don't have to clone your fork to make the edits; you can do everything on GitHub's web UI. Simply open a file in your own forked repo and click on the pencil icon to start editing.

Translating

The trasnlation JSON file consists of key value pairs. The key should give you a good idea of where the text is in the app.

To translate, simply edit the value. For example, let's say you see

"plugin": "Plugin"

Simply change it to:

"plugin": "pLU9IN"

where "pLU9IN" is the phrase "plugin" in the target language. I'm using leetspeak as an example here.

If you encounter something like

"label-welcome": "Welcome, {{name}}!"

leave the {{name}} part alone and do not translate it. "name" is not part of the text and will be replaced by the appropriate value when the app runs.

Existing languages

Here is a table of language code to language name, in alphabetical order. These languages have their template files ready, but are not necessarily ready to be used in the app.

Language code Language name Native name
en (default) English English
de German Deutsch
es Spanish Español
fr French français
id Indonesian Bahasa Indonesia
it Italian Italiano
ja Japanese 日本語
ko Korean 한국어
nl Dutch Nederlands
pl Polish język polski
pt Portuguese Português
ru Russian русский
tr Turkish Türkçe
zh Chinese 中文