• Stars
    star
    348
  • Rank 121,840 (Top 3 %)
  • Language
    TypeScript
  • License
    GNU Affero Genera...
  • Created over 3 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Dictionary - Obsidian Plugin | This plugin adds a multilingual dictionary to the Obsidian note taking tool.

Obsidian Dictionary Plugin GitHub tag (Latest by date) GitHub all releases

This Plugin adds a Dictionary to the Obsidian Note-Taking tool.

Usage

Open the Command Palette (default: ctrl + p), search for Open Dictionary View and run the command. You will see that a new View appears in the right Sidebar of Obsidian. You can set your default Language in Obsidian's Settings under Plugin Options > Obsidian Dictionary > Default Language.

Supported Languages

The following Languages are currently supported:

Language Synonym Popover Sidebar Lookup (Offline Support) UI Translated?
English (US) 🗸 🗸 (🗸) 🗸
English (UK) 🗸 (🗸)
Hindi 🗸
Spanish 🗸 🗸
French 🗸 🗸
Japanese 🗸 🗸
Russian 🗸
German 🗸 🗸 🗸
Italian 🗸 🗸 🗸
Korean 🗸
Brazilian Portuguese 🗸
Arabic 🗸
Turkish 🗸
Chinese 🗸 (🗸) 🗸

How to use this for multiple Languages

To use a different language than your default language for the Dictionary and Synonym Popover you can add a lang or language key into your YAML Frontmatter. Use the following Values for the Language:

Language Key
English (US) en-US
हिन्दी (Hindi) hi
Español (Spanish) es
Français (French) fr
日本語 (Japanese) ja
Русский (Russian) ru
English (UK) en_GB
Deutsch (German) de
Italiano (Italian) it
한국어 (Korean) ko
Português do Brasil (Brazilian Portuguese) pt-BR
اَلْعَرَبِيَّةُ‎ (Arabic) ar
Türkçe (Turkish) tr
中文 (Chinese) zh

Offline Dictionary

As of Release 2.13.0 this Plugin has experimental offline Support for English and Chinese. The offline Dictionary is pretty big (about 35 megabytes), which is why it's not bundled with this Plugin by default. It will download the neccessary files when you are using it for the first time. That means your first look-up still requires an internet connection.

Privacy

This Plugin relies on third-party API's to find Definitions, Synonyms, etc. You can select from a Range of API’s and choose which one to trust, the Plugin will not make requests to API’s you didn’t allow it to. To find more Information about the different API’s click the “More Info“ Button in the Settings.

If you explicitly activate the Advanced Synonym Search, there will be one additional API Call to analyze the whole Sentence the selected Word appears in. This will make the suggested Synonyms more accurate based on the context.

Even though this Plugin is fully Open-Source and thus can be looked over by anyone, the third-party API’s might not be.

How to make this Plugin better

Translations

If you want to help and translate this Plugin to new languages, see locales.

New API's

This Plugin is meant to be easily extensible! If you want to add a new API for a new (or already supported) Language see: API Manager.

You will need to create a new class for the new API, which implements DefinitionProvider or SynonymProvider (or both).

If the Language you are working with doesn't exist yet, add it to the LANGUAGES in _constants.ts.

After that, add the API to the respective List in the API Manager and finally open a Pull Request here on GitHub. This will automatically make it selectable in the Settings.

Special Thanks to @mgmeyers for already making this Plugin a lot better!

Variables

You can edit the Note Template for your local Dictionary in the Settings. Here is a List of Variables you can use:

  • {{notice}} → "Autogenerated by Obsidian Dictionary" (Localized)
  • {{word}} → The Word the File is created for
  • {{pronunciationHeader}} → "Pronunciations" (Localized)
  • {{meaningHeader}} → Same as above, but for "Meanings" (Localized)
  • {{originHeader}} → Same as above, but for "Origin" (Localized)
  • {{phoneticList}} → A List of all phonetics the Plugin found.
  • {{meanings}} → Same as above, but for meanings the Plugin found.
  • {{origin}} → Same as above, but for the word origin the Plugin found.

Localized means, that the Text changes based on Obsidians internal Language.

How to install

  1. Go to Community Plugins in your Obsidian Settings and disable Safe Mode
  2. Click on Browse and search for “Obsidian Dictionary”
  3. Click install
  4. Toggle the Plugin on in the Community Plugins Tab

Support me

If you find this Plugin helpful, consider supporting me:

This Plugin relies on the Free Dictionary API by meetDeveloper. He is providing this API to the public for free and needs help from the community. More Information

More Repositories

1

obsidian-commander

Commander - Obsidian Plugin | Add Commands to every part of Obsidian's user interface
TypeScript
657
star
2

obsidian-charts

Charts - Obsidian Plugin | Create editable, interactive and animated Charts in Obsidian via Chart.js
TypeScript
546
star
3

obsidian-emoji-shortcodes

Emoji Shortcodes - Obsidian Plugin | Adds Support for Emoji Shortcodes to Obsidian
TypeScript
175
star
4

obsidian-advanced-toolbar

Advanced Toolbar - Obsidian Plugin | Enhances Obsidian Mobile's Quick Action Toolbar
TypeScript
88
star
5

obsidian-customizable-sidebar

This Plugin allows you to add every Command to Obsidian's Sidebar Ribbon and add Custom Icons.
TypeScript
81
star
6

obsidian-latex-css

A LaTeX inspired CSS Snippet for PDF's exported with Obsidian.
SCSS
71
star
7

obsidian-tabout

A port of VSCode's Tabout for Obsidian.
TypeScript
49
star
8

obsidian-open-with

TypeScript
34
star
9

obsidian-macros

Group multiple Commands into one Macro.
TypeScript
19
star
10

obsidian-plugin-changelogs

Plugin Changelogs - Obsidian Plugin | View the Changelogs of Plugins inside Obsidian
Svelte
18
star
11

obsidian-go-to-line

TypeScript
15
star
12

obsidian-toggleable-vim

Provides additional Hotkeys to turn Obsidian's Vim Emulation on and off
TypeScript
13
star
13

obsidian-extended-context-menu

Provides an API for other Obsidian Plugins to create custom Context Menus in the Editor without them overriding each other.
TypeScript
11
star
14

obsidian-relative-find

TypeScript
9
star
15

obsidian-hot-notes

Shows the "temperature" of your Notes in Obsidian's iconic Graph View!
TypeScript
6
star
16

ml-in-mobile-apps

Meine Facharbeit im Fach Informatik zum Thema "Machine Learning in Smartphone Apps". Q1
TeX
3
star
17

labelcheck

A Cross-Platform Application using TensorFlow-Lite and Flutter to recognize labels on fruits or vegetables to get more information about their trustworthiness.
Dart
3
star
18

obsidian-plugin-template

My Obsidian Plugin Template
JavaScript
1
star
19

cavesncliffs

Caves N' Cliffs Multiplayer Minecraft SMP
Dart
1
star
20

zed-min-theme

Shell
1
star