{"id":13408198,"url":"https://github.com/yomidevs/yomitan","last_synced_at":"2025-10-06T16:30:29.806Z","repository":{"id":110629224,"uuid":"609539390","full_name":"yomidevs/yomitan","owner":"yomidevs","description":"Pop-up dictionary browser extension for language learning. Successor to Yomichan.","archived":false,"fork":true,"pushed_at":"2025-10-01T03:06:41.000Z","size":106051,"stargazers_count":2052,"open_issues_count":229,"forks_count":172,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-10-04T12:05:52.814Z","etag":null,"topics":["anki","chrome","chrome-extension","dictionaries","dictionary","extension","firefox","japanese","japanese-language","japanese-study","language","language-learning","yomichan","yomitan"],"latest_commit_sha":null,"homepage":"https://yomitan.wiki","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"FooSoft/yomichan","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yomidevs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null}},"created_at":"2023-03-04T13:40:07.000Z","updated_at":"2025-10-04T11:44:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"c77e94c2-a42f-4c25-aa3f-3cf08af84082","html_url":"https://github.com/yomidevs/yomitan","commit_stats":null,"previous_names":["yomidevs/yomitan","themoeway/yomitan"],"tags_count":240,"template":false,"template_full_name":null,"purl":"pkg:github/yomidevs/yomitan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yomidevs%2Fyomitan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yomidevs%2Fyomitan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yomidevs%2Fyomitan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yomidevs%2Fyomitan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yomidevs","download_url":"https://codeload.github.com/yomidevs/yomitan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yomidevs%2Fyomitan/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278643214,"owners_count":26021058,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["anki","chrome","chrome-extension","dictionaries","dictionary","extension","firefox","japanese","japanese-language","japanese-study","language","language-learning","yomichan","yomitan"],"created_at":"2024-07-30T20:00:51.363Z","updated_at":"2025-10-06T16:30:24.797Z","avatar_url":"https://github.com/yomidevs.png","language":"JavaScript","funding_links":[],"categories":["Browser-based","JavaScript"],"sub_categories":[],"readme":"# Yomitan\n\n[![Get Yomitan for Chrome](\u003chttps://img.shields.io/chrome-web-store/v/likgccmbimhjbgkjambclfkhldnlhbnn?logo=Google%20Chrome\u0026style=for-the-badge\u0026logoColor=lightblue\u0026color=lightblue\u0026label=get%20yomitan%20for%20chrome%20(stable)\u003e)](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn)\n[![Get Yomitan for Firefox](\u003chttps://img.shields.io/amo/v/yomitan?logo=Firefox\u0026style=for-the-badge\u0026color=orange\u0026label=get%20yomitan%20for%20firefox%20(stable)\u003e)](https://addons.mozilla.org/en-US/firefox/addon/yomitan/)\n[![Get Yomitan for Edge](https://img.shields.io/badge/dynamic/json?logo=puzzle\u0026label=get%20yomitan%20for%20edge\u0026style=for-the-badge\u0026query=%24.version\u0026url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Fidelnfbbmikgfiejhgmddlbkfgiifnnn)](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/yomidevs/yomitan/badge?style=for-the-badge)](https://securityscorecards.dev/viewer/?uri=github.com/yomidevs/yomitan)\n\n[![Discord](https://dcbadge.vercel.app/api/server/YkQrXW6TXF?style=for-the-badge)](https://discord.gg/YkQrXW6TXF)\n\n# Visit [yomitan.wiki](https://yomitan.wiki) to learn more!\n\n:wave: **Yomitan is [the successor](https://foosoft.net/posts/passing-the-torch-to-yomitan/) to Yomichan** ([migration guide](https://yomitan.wiki/yomichan-migration/)) 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**.\n\n📢 **New contributors [welcome](#contributing)!**\n\n📢 **Interested in adding a new language to Yomitan? See [here](./docs/development/language-features.md) for thorough documentation!**\n\n## What is Yomitan?\n\nYomitan 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](https://yomitan.wiki/supported-languages/).\n\nYomitan provides powerful features not available in other browser-based dictionaries:\n\n- 💬 Interactive popup definition window for displaying search results.\n- 🔊 Built-in native pronunciation audio with the ability to add your own [custom audio sources](https://yomitan.wiki/advanced/#default-audio-sources).\n- ✍️ Kanji stroke order diagrams are just a click away.\n- 📝 [Automatic flashcard creation](https://yomitan.wiki/anki/) for the [Anki](https://apps.ankiweb.net/) flashcard program via the [AnkiConnect](https://foosoft.net/projects/anki-connect) plugin.\n- 🔍 Custom search page for easily executing custom search queries.\n- 📖 Support for multiple dictionary formats including [EPWING](https://ja.wikipedia.org/wiki/EPWING) via the [Yomitan Import](https://github.com/yomidevs/yomitan-import) tool.\n- ✨ Clean, modern code makes it easy for developers to [contribute](#contributing) new features and languages.\n\n[![Term definitions](img/ss-terms-thumb.png)](img/ss-terms.png)\n[![Kanji information](img/ss-kanji-thumb.png)](img/ss-kanji.png)\n[![Dictionary options](img/ss-dictionaries-thumb.png)](img/ss-dictionaries.png)\n[![Anki options](img/ss-anki-thumb.png)](img/ss-anki.png)\n\n## Documentation/How To\n\n**Please visit the [Yomitan Wiki](https://yomitan.wiki) for the most up-to-date usage documentation.**\n\n### Developer Documentation\n\n- Dictionaries\n  - 🛠️ [Making Yomitan Dictionaries](./docs/making-yomitan-dictionaries.md)\n- Anki Integration\n  - 🔧 [Anki handlebar templates](./docs/templates.md)\n- Advanced Features\n- Troubleshooting\n  - 🕷️ [Known browser bugs](./docs/browser-bugs.md)\n\n## Installation\n\nYomitan 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/yomidevs/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.\n\n- **Google Chrome**\n\n  - [stable](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn)\n  - [testing](https://chrome.google.com/webstore/detail/yomitan-development-build/glnaenfapkkecknnmginabpmgkenenml)\n\n- **Mozilla Firefox**\n\n  - [stable](https://addons.mozilla.org/en-US/firefox/addon/yomitan/)\n  - [testing](https://github.com/yomidevs/yomitan/releases) ※\n\n- **Microsoft Edge**\n  - [stable](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn)\n  - Testing: Coming soon\n\n※ 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.\n\n## Contributing\n\n🚀 **Dip your toes into contributing by looking at issues with the label [good first issue](https://github.com/yomidevs/yomitan/issues?q=is%3Aissue+is%3Aopen+label%3A%22gоοd+fіrst+іssսe%22).**\n\nSince this is a distributed effort, we **highly welcome new contributors**! Feel free to browse the [issue tracker](https://github.com/yomidevs/yomitan/issues), and read our [contributing guidelines](./CONTRIBUTING.md).\n\nHere are some ways anyone can help:\n\n- 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.\n- Document any UI/UX friction in GitHub Issues. We're looking to make Yomitan more accessible to non-technical users.\n- 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.\n\n\u003e 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.\n\nIf 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.\n\nSome contributions we always appreciate:\n\n- Well-written tests covering different functionalities. This includes [playwright tests](https://github.com/yomidevs/yomitan/tree/master/test/playwright), [benchmark tests](https://github.com/yomidevs/yomitan/tree/master/benches), and unit tests.\n- Increasing our type coverage.\n- More and better documentation!\n\nInformation on how to setup and build the codebase can be found [here](./CONTRIBUTING.md#setup).\n\nIf you want to add or improve support for a language, read the documentation on [language features](./docs/development/language-features.md).\n\nFeel free to join us on the [Yomitan Discord](https://discord.gg/YkQrXW6TXF).\n\n## Building Yomitan\n\n1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).\n\n2. Run `npm ci` to set up the environment.\n\n3. Run `npm run license-report:html` to generate any missing or changed license information.\n\n4. Run `npm run build` for a plain testing build or `npm run-script build -- --all --version {version}` for a release build (replacing `{version}` with a version number).\n\n5. The builds for each browser and release branch can be found in the `builds` directory.\n\nFor more information, see [Contributing](./CONTRIBUTING.md#setup).\n\n## Third-Party Libraries\n\nYomitan uses several third-party libraries to function.\n\n\u003c!-- The following table is generated using the command `npm run license-report:markdown`. --\u003e\n\n| Name                | Installed version | License type | Link                                             |\n| :------------------ | :---------------- | :----------- | :----------------------------------------------- |\n| @zip.js/zip.js      | 2.7.32            | BSD-3-Clause | git+https://github.com/gildas-lormeau/zip.js.git |\n| dexie               | 3.2.4             | Apache-2.0   | git+https://github.com/dfahlander/Dexie.js.git   |\n| dexie-export-import | 4.0.7             | Apache-2.0   | git+https://github.com/dexie/Dexie.js.git        |\n| yomitan-handlebars  | 1.0.0             | MIT          | n/a                                              |\n| parse5              | 7.1.2             | MIT          | git://github.com/inikulin/parse5.git             |\n| wanakana            | 5.3.1             | MIT          | git+ssh://git@github.com/WaniKani/WanaKana.git   |\n| hangul.js           | 0.2.6             | MIT          | git+https://github.com/e-/Hangul.js.git          |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyomidevs%2Fyomitan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyomidevs%2Fyomitan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyomidevs%2Fyomitan/lists"}