{"id":23350756,"url":"https://github.com/mirryi/wikichan","last_synced_at":"2025-08-23T11:32:30.803Z","repository":{"id":38380688,"uuid":"318544250","full_name":"mirryi/wikichan","owner":"mirryi","description":"A WebExtension and userscript that displays information from Wikipedia and other sources in a popup for the hovered text.","archived":false,"fork":false,"pushed_at":"2023-02-05T03:33:00.000Z","size":2780,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-06T21:22:00.917Z","etag":null,"topics":["addon","dictionary","greasemonkey","popup","userscript","webextension","wikipedia"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mirryi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-04T14:40:48.000Z","updated_at":"2022-01-22T14:37:15.000Z","dependencies_parsed_at":"2023-02-08T02:49:00.006Z","dependency_job_id":null,"html_url":"https://github.com/mirryi/wikichan","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirryi%2Fwikichan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirryi%2Fwikichan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirryi%2Fwikichan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mirryi%2Fwikichan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mirryi","download_url":"https://codeload.github.com/mirryi/wikichan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230688697,"owners_count":18265270,"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":["addon","dictionary","greasemonkey","popup","userscript","webextension","wikipedia"],"created_at":"2024-12-21T08:18:03.824Z","updated_at":"2024-12-21T08:18:04.379Z","avatar_url":"https://github.com/mirryi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wikichan\n\n**Wikichan** is a WebExtensions addon and userscript that displays a popup with\ninformation from Wikipedia and other sources.\n\n## Features\n\n-   Wikipedia article summary source\n-   English dictionary source via OwlBot\n-   Search bar to manually query providers\n-   Open links to source pages\n\nSee [To-Do](#to-do) for upcoming features.\n\n## Usage\n\nWhile holding the `ctrl` key, click on a word in any webpage. A popup will\nappear with information for that word and groups of words around it.\n\n## Installation\n\nAutomated release builds and addon store entries coming soon.\n\nClone and build from source for your platform.\n\n    git clone --recurse-submodules https://github.com/Dophin2009/wikichan\n    cd wikichan\n    yarn install\n\nIf you want to enable the OwlBot provider, [create an OwlBot API\nkey](https://owlbot.info/) and create a `.env` file:\n\n    OWLBOT_TOKEN=\u003ctoken\u003e\n\n### Greasemonkey Userscript\n\nThe userscript has been tested on Tampermonkey. It **does not work on\nGreasemonkey**.\n\nBuild the script and copy:\n\n    yarn build:ujs      # builds to dist/ujs/wikichan.user.js\n\n#### For Qutebrowser\n\nUntil qutebrowser has better Greasemonkey support ([see\n\\#3238](https://github.com/qutebrowser/qutebrowser/issues/3238)), persistent\ncross-domain storage is accomplished via a tiny server with an SQLite database.\n\nBuild the script and copy files:\n\n    yarn build:qutebrowser  # builds to dist/qutebrowser/\n\nYou will need to start the server when you start up qutebrowser.\n\n### Firefox Addon\n\nBuild and sign the addon:\n\n    yarn build:firefox  # builds to dist/firefox\n    cd dist/firefox\n    yarn web-ext sign --api-key \u003capi-key\u003e --api-secret \u003capi-secret\u003e\n\n### Chrome Extension\n\nBuild the extension:\n\n    yarn build:chrome   # builds to dist/chrome\n\n### With Docker\n\nPass in the desired target value:\n\n    DOCKER_BUILDKIT=1 docker build --build-arg TARGET=\u003ctarget\u003e --output dist .\n\n## Contributing\n\n### To-Do\n\nCurrent work is being done on the `rearch` branch.\n\n-   [x] Manifest and build WebExtension\n-   [x] Cache results (per provider)\n-   [ ] More provider choices\n    -   [x] English dictionary provider\n    -   [ ] Any language Wikipedia\n    -   [ ] Other language dictionary\n-   [ ] Settings menu\n    -   [ ] Use library for certain cache/storage backends\n    -   [x] Cross-domain cache and settings in qutebrowser\n    -   [ ] Input API tokens instead of at compile-time\n    -   [ ] Enable/disable providers\n    -   [ ] Dark/light themes (migrate to styled components?)\n    -   [ ] Option to select by character\n    -   [ ] Per-domain settings\n-   [ ] Tabs to show results from individual providers\n-   [ ] Automated release builds\n-   [ ] Testing\n-   [ ] i18n\n-   [ ] Legacy extension support\n\n## Credits\n\nThis project was inspired heavily by the extension\n[Yomichan](https://foosoft.net/projects/yomichan), a Japanese-learning tool.\n\nCreated originally for Conestoga High School's 2018 CodeFest.\n\n## License\n\nThis project is licensed under the GNU Public License v3. See [LICENSE](LICENSE)\nfor more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirryi%2Fwikichan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmirryi%2Fwikichan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmirryi%2Fwikichan/lists"}