Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/themoeway/yomitan
Japanese pop-up dictionary browser extension. Successor to Yomichan.
https://github.com/themoeway/yomitan
anki chrome chrome-extension dictionaries dictionary extension firefox japanese japanese-language japanese-study language language-learning yomichan yomitan
Last synced: about 1 month ago
JSON representation
Japanese pop-up dictionary browser extension. Successor to Yomichan.
- Host: GitHub
- URL: https://github.com/themoeway/yomitan
- Owner: themoeway
- License: gpl-3.0
- Fork: true (FooSoft/yomichan)
- Created: 2023-03-04T13:40:07.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-19T07:28:12.000Z (4 months ago)
- Last Synced: 2024-07-19T15:08:12.779Z (4 months ago)
- Topics: anki, chrome, chrome-extension, dictionaries, dictionary, extension, firefox, japanese, japanese-language, japanese-study, language, language-learning, yomichan, yomitan
- Language: JavaScript
- Homepage: https://chromewebstore.google.com/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn
- Size: 95.3 MB
- Stars: 967
- Watchers: 7
- Forks: 73
- Open Issues: 174
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-immersion - Yomitan - fork of Yomichan by [TheMoeWay](https://github.com/themoeway). (Browser-based)
README
# Yomitan
[![Get Yomitan for Chrome]()](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn)
[![Get Yomitan for Firefox]()](https://addons.mozilla.org/en-US/firefox/addon/yomitan/)
[](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn)
[](https://discord.gg/UGNPMDE7zC)
[](https://securityscorecards.dev/viewer/?uri=github.com/themoeway/yomitan)
# Visit [yomitan.wiki](https://yomitan.wiki) to learn more!
:wave: **Yomitan is [the successor](https://foosoft.net/posts/passing-the-torch-to-yomitan/) to Yomichan** ([migration guide](./docs/yomichan-migration.md#migrating-from-yomichan)) which was [sunset](https://foosoft.net/posts/sunsetting-the-yomichan-project/) by its owner on Feb 26, 2023. We have made a number of foundational changes to ensure **the project stays alive, works on latest browser versions, and is easy to contribute to**.
📢 **New contributors [welcome](#contributing)!**
📢 **Interested in adding a new language to Yomitan? See [here](./docs/development/language-features.md) for thorough documentation!**
## What is Yomitan?
Yomitan turns your web browser into a tool for building language literacy by helping you **read** texts that would otherwise be too difficult to tackle in [a variety of supported languages](./docs/supported-languages.md).
Yomitan provides powerful features not available in other browser-based dictionaries:
- 💬 Interactive popup definition window for displaying search results.
- 🔊 Built-in native pronunciation audio with the ability to add your own [custom audio sources](./docs/audio.md).
- ✍️ Kanji stroke order diagrams are just a click away.
- 📝 [Automatic flashcard creation](./docs/anki-integration.md#anki-integration) for the [Anki](https://apps.ankiweb.net/) flashcard program via the [AnkiConnect](https://foosoft.net/projects/anki-connect) plugin.
- 🔍 Custom search page for easily executing custom search queries.
- 📖 Support for multiple dictionary formats including [EPWING](https://ja.wikipedia.org/wiki/EPWING) via the [Yomitan Import](https://github.com/themoeway/yomitan-import) tool.
- ✨ Clean, modern code makes it easy for developers to [contribute](#contributing) new features and languages.
[](img/ss-terms.png)
[](img/ss-kanji.png)
[](img/ss-dictionaries.png)
[](img/ss-anki.png)
## Helpful information
- ✨ [Migrating from Yomichan (legacy)](./docs/yomichan-migration.md)
- Dictionaries
- 📚 [Recommended Dictionaries](./docs/dictionaries.md#recommended-dictionaries)
- 🗂️ [Importing and exporting dictionaries](./docs/dictionaries.md#importing-a-dictionary-collection)
- 🛠️ [Making Yomitan Dictionaries](./docs/making-yomitan-dictionaries.md)
- Anki Integration
- 📇 [Anki integration and flashcard creation guide](./docs/anki-integration.md)
- 🔧 [Anki handlebar templates](./docs/templates.md)
- Advanced Features
- ⌨️ [Keyboard shortcuts](./docs/keyboard-shortcuts.md)
- 🔍 [Advanced options, including MeCab](./docs/advanced-options.md)
- 🔊 [Adding custom audio sources](./docs/audio.md)
- Troubleshooting
- 🕷️ [Known browser bugs](./docs/browser-bugs.md)
- ❓ [Frequently asked questions](./docs/faq.md)
- 🔒 [Browser Permissions](./docs/permissions.md)
- 🌎 [Supported Languages](./docs/supported-languages.md)
## Installation
Yomitan comes in two flavors: _stable_ and _testing_. New changes are initially introduced into the _testing_ version, and after some time spent ensuring that they are relatively bug free, they will be promoted to the _stable_ version. If you are technically savvy and don't mind [submitting issues](https://github.com/themoeway/yomitan/issues/new/choose) on GitHub, try the _testing_ version; otherwise, the _stable_ version will be your best bet. Check [contributing](#contributing) for more information on how to help.
- **Google Chrome**
- [stable](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn)
- [testing](https://chrome.google.com/webstore/detail/yomitan-development-build/glnaenfapkkecknnmginabpmgkenenml)
- **Mozilla Firefox**
- [stable](https://addons.mozilla.org/en-US/firefox/addon/yomitan/)
- [testing](https://github.com/themoeway/yomitan/releases) ※
- **Microsoft Edge**
- [stable](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn)
- Testing: Coming soon
※ Unlike Chrome, Firefox does not allow extensions meant for testing to be hosted in the marketplace. You will have to download the desired version and side-load it yourself. You only need to do this once, and you will get updates automatically.
## Basic Usage
1. Click the 
_Yomitan_ button in the browser bar to open the quick-actions popup.
- The 
_cog_ button will open the Settings page.
- The 
_magnifying glass_ button will open the Search page.
- The 
_question mark_ button will open the Information page.
- The 
_profile_ button will appear when multiple profiles exist, allowing the current profile to be quickly changed.
2. Import the dictionaries you wish to use for term and kanji searches; head over to the [dictionary docs](./docs/dictionaries.md) to get set up! If you do not have any dictionaries installed or enabled, Yomitan will warn you that it is not ready for use by displaying an orange exclamation mark over its icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary.
3. Webpage text can be scanned by moving the cursor while holding a modifier key, which is Shift by default. If definitions are found for the text at the cursor position, a popup window containing term definitions will open. This window can be dismissed by clicking anywhere outside of it.
4. Click on the 
_speaker_ button to hear the term pronounced by a native speaker. If an audio sample is not available, you will hear a short click instead. For more options, see [Audio Configuration](./docs/audio.md).
5. Click on individual kanji in the term definition results to view additional information about those characters, including stroke order diagrams, readings, meanings, and other useful data.
To further enhance your Yomitan experience, it's worth [integrating with Anki](./docs/anki-integration.md), a spaced-repetition flashcard program to help solidify the words you encounter.
## Contributing
🚀 **Dip your toes into contributing by looking at issues with the label [good first issue](https://github.com/themoeway/yomitan/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).**
Since this is a distributed effort, we **highly welcome new contributors**! Feel free to browse the [issue tracker](https://github.com/themoeway/yomitan/issues), and read our [contributing guidelines](./CONTRIBUTING.md).
Here are some ways anyone can help:
- Try using the Yomitan dev build. Not only do you get cutting edge features, but you can help uncover bugs and give feedback to developers early on.
- Document any UI/UX friction in Github Issues. We're looking to make Yomitan more accessible to non-technical users.
- All the issues in `area/bug` older than 2 months need help reproducing. If anything interests you, please try to reproduce it and report your results. We can't easily tell if these issues are one-off, have since been resolved, or are no longer relevant.
> The current active maintainers of Yomitan spend a lot of their time debugging and triaging issues. When someone files a bug report, we need to assess the frequency and severity of the bug. It is extremely helpful if we get multiple reports of people who experience a bug or people who can contribute additional detail to an existing bug report.
If you're looking to code, please let us know what you plan on working on before submitting a Pull Request. This gives the core maintainers an opportunity to provide feedback early on before you dive too deep. You can do this by opening a Github Issue with the proposal.
Some contributions we always appreciate:
- Well-written tests covering different functionalities. This includes [playwright tests](https://github.com/themoeway/yomitan/tree/master/test/playwright), [benchmark tests](https://github.com/themoeway/yomitan/tree/master/benches), and unit tests.
- Increasing our type coverage.
- More and better documentation!
Information on how to setup and build the codebase can be found [here](./CONTRIBUTING.md#setup).
If you want to add or improve support for a language, read the documentation on [language features](./docs/development/language-features.md).
Feel free to join us on [TheMoeWay Discord 🐇](https://discord.gg/UGNPMDE7zC) at [#yomitan-development](https://discord.com/channels/617136488840429598/1081538711742844980).
## Third-Party Libraries
Yomitan uses several third-party libraries to function.
| Name | Installed version | License type | Link |
| :------------------ | :---------------- | :----------- | :----------------------------------------------- |
| @zip.js/zip.js | 2.7.32 | BSD-3-Clause | git+https://github.com/gildas-lormeau/zip.js.git |
| dexie | 3.2.4 | Apache-2.0 | git+https://github.com/dfahlander/Dexie.js.git |
| dexie-export-import | 4.0.7 | Apache-2.0 | git+https://github.com/dexie/Dexie.js.git |
| yomitan-handlebars | 1.0.0 | MIT | n/a |
| parse5 | 7.1.2 | MIT | git://github.com/inikulin/parse5.git |
| wanakana | 5.3.1 | MIT | git+ssh://[email protected]/WaniKani/WanaKana.git |
| hangul.js | 0.2.6 | MIT | git+https://github.com/e-/Hangul.js.git |