{"id":13597156,"url":"https://github.com/phibr0/obsidian-dictionary","last_synced_at":"2025-04-05T06:06:03.271Z","repository":{"id":39339069,"uuid":"366783424","full_name":"phibr0/obsidian-dictionary","owner":"phibr0","description":"Dictionary - Obsidian Plugin | This plugin adds a multilingual dictionary to the Obsidian note taking tool.","archived":false,"fork":false,"pushed_at":"2024-02-16T22:08:47.000Z","size":11588,"stargazers_count":389,"open_issues_count":34,"forks_count":49,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T05:07:39.402Z","etag":null,"topics":["dictionary","obsidian-md","obsidian-plugin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phibr0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["phibr0"],"custom":["https://www.buymeacoffee.com/phibr0"]}},"created_at":"2021-05-12T16:37:31.000Z","updated_at":"2025-03-20T02:47:40.000Z","dependencies_parsed_at":"2024-01-14T04:43:05.546Z","dependency_job_id":"fe73ae8c-6868-4f8f-87f1-29f36ca8cf62","html_url":"https://github.com/phibr0/obsidian-dictionary","commit_stats":null,"previous_names":[],"tags_count":98,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phibr0%2Fobsidian-dictionary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phibr0%2Fobsidian-dictionary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phibr0%2Fobsidian-dictionary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phibr0%2Fobsidian-dictionary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phibr0","download_url":"https://codeload.github.com/phibr0/obsidian-dictionary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294537,"owners_count":20915340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dictionary","obsidian-md","obsidian-plugin"],"created_at":"2024-08-01T17:00:22.435Z","updated_at":"2025-04-05T06:06:03.239Z","avatar_url":"https://github.com/phibr0.png","language":"TypeScript","funding_links":["https://github.com/sponsors/phibr0","https://www.buymeacoffee.com/phibr0","https://img.buymeacoffee.com/button-api/?text=Buy"],"categories":["社区汉化指引","TypeScript"],"sub_categories":["欢迎参与汉化的热门插件"],"readme":"\u003cimg align=\"right\" style=\"width: 27vw\" src=\"https://media.discordapp.net/attachments/796853434397360128/847198380878069771/Screen_Shot_2021-05-26_at_12.43.43_PM.png?width=736\u0026height=676\"\u003e\r\n\r\n# Obsidian Dictionary Plugin [![GitHub tag (Latest by date)](https://img.shields.io/github/v/tag/phibr0/obsidian-dictionary)](https://github.com/phibr0/obsidian-dictionary/releases) ![GitHub all releases](https://img.shields.io/github/downloads/phibr0/obsidian-dictionary/total)\r\n\r\nThis Plugin adds a Dictionary to the [Obsidian](https://obsidian.md) Note-Taking tool.\r\n\r\n## Usage\r\n\r\nOpen 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* \u003e *Obsidian Dictionary* \u003e *Default Language*.\r\n\r\n## Supported Languages\r\n\r\nThe following Languages are currently supported:\r\n\r\n| Language             | Synonym Popover | Sidebar Lookup (Offline Support) | UI Translated? |\r\n|:-------------------- |:---------------:|:--------------:|:-----------:|\r\n| English (US)         |        🗸        |       🗸  (🗸)       |🗸|\r\n| English (UK)         |                 |       🗸 (🗸)       ||\r\n| Hindi                |                 |       🗸        ||\r\n| Spanish              |        🗸        |       🗸        ||\r\n| French               |        🗸        |       🗸        ||\r\n| Japanese             |                 |       🗸        |🗸|\r\n| Russian              |                 |       🗸        ||\r\n| German               |        🗸        |       🗸        |🗸|\r\n| Italian              |        🗸        |       🗸        |🗸|\r\n| Korean               |                 |       🗸        ||\r\n| Brazilian Portuguese |                 |       🗸        ||\r\n| Arabic               |                 |       🗸        ||\r\n| Turkish              |                 |       🗸        | |\r\n| Chinese | | 🗸 (🗸) | 🗸 |\r\n\r\n### How to use this for multiple Languages\r\n\r\nTo 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:\r\n\r\n| Language | Key |\r\n|---|:---:|\r\nEnglish (US)|`en-US`\r\nहिन्दी (Hindi)|`hi`\r\nEspañol (Spanish)|`es`\r\nFrançais (French)|`fr`\r\n日本語 (Japanese)|`ja`\r\nРусский (Russian)|`ru`\r\nEnglish (UK)|`en_GB`\r\nDeutsch (German)|`de`\r\nItaliano (Italian)|`it`\r\n한국어 (Korean)|`ko`\r\nPortuguês do Brasil (Brazilian Portuguese)|`pt-BR`\r\nاَلْعَرَبِيَّةُ‎ (Arabic)|`ar`\r\nTürkçe (Turkish)|`tr`\r\n中文 (Chinese)|`zh`\r\n\r\n## Offline Dictionary\r\n\r\nAs 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.\r\n\r\n## Privacy\r\n\r\nThis Plugin relies on third-party [API's](https://en.wikipedia.org/wiki/API) 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.\r\n\r\nIf 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.\r\n\r\nEven though this Plugin is fully Open-Source and thus can be looked over by anyone, the third-party API’s might not be.\r\n\r\n## How to make this Plugin better\r\n\r\n### Translations\r\n\r\nIf you want to help and translate this Plugin to new languages, see [locales](https://github.com/phibr0/obsidian-dictionary/tree/master/src/l10n/locale).\r\n\r\n### New API's\r\n\r\nThis 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](src/apiManager.ts).\r\n\r\nYou will need to create a new class for the new API, which implements [DefinitionProvider](src/api/types.ts) or [SynonymProvider](src/api/types.ts) (or both).\r\n\r\nIf the Language you are working with doesn't exist yet, add it to the `LANGUAGES` in [_constants.ts](src/_constants.ts).\r\n\r\nAfter that, add the API to the respective List in the [API Manager](src/apiManager.ts) and finally open a Pull Request here on GitHub.\r\nThis will automatically make it selectable in the Settings.\r\n\r\n\u003e Special Thanks to [@mgmeyers](https://github.com/mgmeyers) for already making this Plugin a lot better!\r\n\r\n## Variables\r\n\r\nYou can edit the Note Template for your local Dictionary in the Settings. Here is a List of Variables you can use:\r\n\r\n- `{{notice}}` → \"Autogenerated by Obsidian Dictionary\" (Localized)\r\n- `{{word}}` → The Word the File is created for\r\n- `{{pronunciationHeader}}` → \"Pronunciations\" (Localized)\r\n- `{{meaningHeader}}` → Same as above, but for \"Meanings\" (Localized)\r\n- `{{originHeader}}` → Same as above, but for \"Origin\" (Localized)\r\n- `{{phoneticList}}` → A List of all phonetics the Plugin found.\r\n- `{{meanings}}` → Same as above, but for meanings the Plugin found.\r\n- `{{origin}}` → Same as above, but for the word origin the Plugin found.\r\n\r\nLocalized means, that the Text changes based on Obsidians internal Language.\r\n\r\n## How to install\r\n\r\n1. Go to **Community Plugins** in your [Obsidian](https://www.obsidian.md) Settings and **disable** Safe Mode\r\n2. Click on **Browse** and search for “Obsidian Dictionary”\r\n3. Click install\r\n4. Toggle the Plugin on in the **Community Plugins** Tab\r\n\r\n## Support me\r\n\r\nIf you find this Plugin helpful, consider supporting me:\r\n\r\n\u003ca href=\"https://www.buymeacoffee.com/phibr0\"\u003e\u003cimg src=\"https://img.buymeacoffee.com/button-api/?text=Buy me a coffee\u0026emoji=\u0026slug=phibr0\u0026button_colour=5F7FFF\u0026font_colour=ffffff\u0026font_family=Inter\u0026outline_colour=000000\u0026coffee_colour=FFDD00\"\u003e\u003c/a\u003e\r\n\r\n\u003e This Plugin relies on the [Free Dictionary API](https://dictionaryapi.dev/) by [meetDeveloper](https://github.com/meetDeveloper). He is providing this API to the public for free and needs help from the community. [**More Information**](https://github.com/meetDeveloper/freeDictionaryAPI#important-note)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphibr0%2Fobsidian-dictionary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphibr0%2Fobsidian-dictionary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphibr0%2Fobsidian-dictionary/lists"}