Skip to content

An plugin for Obsidian that translates note names to ease linking across many languages.

License

Notifications You must be signed in to change notification settings

leolazou/obsidian-multilingual

Repository files navigation

Obsidian Multilingual

Simplifies Obsidian's powerful linking for multilingual users. This plugin automatically translates note names into multiple languages and allows you to easily link your notes across all the languages you use.

The Idea ๐Ÿ”ฎ

Many users of Obsidian use more than one language in their everyday life, but their thoughts are all connected across languages. The goal is to simplify the amazing linking logic of Obsidian for multilingual users, by allowing to more easily link notes and ideas in the current note language. While Obsidian offers aliases to answer this need, writing them manually for every note you create is frustrating. Why bother, when a plugin can do it for you?


Obsidian Multilingual demo


Features ๐Ÿช„

  • ๐Ÿ‘ Translate note names into desired languages. Translations are added to the aliases, which allows you to link your notes in all of the languages you use.
  • ๐Ÿ‘ Automatic translation of the names when you create a new note or rename an existing one.
  • ๐Ÿ› ๏ธ You can specify a folder, regex and date format to be ignored from automatic translation. YYYY-MM-DD are never automatically translated.
  • ๐Ÿ’ก The plugin leverages Obsidian aliases, so that all links remain functional even if the plugin uninstalled.

Limitations, as of now:

  • ๐Ÿคทโ€โ™‚๏ธ Does not remove old aliases when a note is renamed (only adds new translations). This is notably because in Obsidian changing note aliases (even manually) does not change the actual links in other notes.

Usage โœ๏ธ

  1. Install & enable Obsidian Multilingual directly from Obsidian: Settings โ†’ Community plugins โ†’ Browse
  2. Go to the plugin settings in Settings โ†’ Multilingual
  3. List the languages you use for writing in Obsidian
  4. create an API key for the translation service of your choice and paste it in the specified field. How-to links below.
  5. Translate note name with the ribbon icon, command or riight-click menu.
  6. Or just notice translations added automatically when you create and rename notes with "Auto translate" (ON by default).
  7. (Advanced) You can specify a folder, regex and date format to be ignored from automatic translation. YYYY-MM-DD are never automatically translated.

(Creating an API key is mandatory, the plugin will not work without it.)

Translation services ๐Ÿ™Š๐Ÿ™‰

You can choose between:

Both are free to use for up to 500,000 characters per month, which is usually a lot higher than what you might require for using this plugin, even with a heavy use of Obsidian.

Example If you name your notes in English and translate the note names into 2 more languages, you'll need to create approximately 10,000 notes per month to reach the free limit. Sounds like a challenge?

Quick Comparison

Google Cloud Translation DeepL
advantages (imho) more languages, great translations more accurate and natural-sounding translations, easier to set up
supported languages ~134 (list) ~33 (list)
free usage limit 500,000 characters / month 500,000 characters / month
credit card required ? yes.
(but you can set a $0 spending limit)
yes, only for ID verification
(to avoid free usage abuse)
ease of setup harder easy
how to get an API key - Docs
- A step-by-step guide by Gemini
- A helpful video
- Docs
- A step-by-step guide by ChatGPT
- A helpful video

Privacy & Legal ๐Ÿ•ต๏ธ

The text (note names) the user will translate using this plugin - both manually and automatically when "Auto translate" is ON - will be sent to Google / DeepL for translation. Refer to:

Obsidian Multilingual is not officialy affiliated with any of the translation services mentioned above.

Inspirations ๐Ÿ’ญ

While no code was directly copy-pasted, I learnt a lot from the following projects to make it work:

Coffee โ˜•๏ธ

Buy Me a Coffee at ko-fi.com

...or a couple of croissants ๐Ÿฅ, but it's basically the same link.

About

An plugin for Obsidian that translates note names to ease linking across many languages.

Resources

License

Stars

Watchers

Forks

Packages

No packages published