Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 3.9 KB

README.md

File metadata and controls

58 lines (34 loc) · 3.9 KB
Raw

WikiChrome

About

Context: I've always liked reading about random things I find or find interesting on the internet in Wikipedia, but up until now, I'd have to search everything I found in google manually, and then go to Wikipedia. That got me thinking about a lazier efficient way to be able to open Wikipedia pages straight from the browser window. This would eventually become the idea for this project.

Chrome Web Extension built in TypeScript using Chrome API. Simple way to open highlighted text as a Wikipedia article from right click menu or configurable keyboard shortcut.

Currently under review for publishing in Chrome Web Store! :D

Built With

TypeScript ts-jest Chrome API

Usage

  1. At chrome://extensions, navigate to keyboard shortcuts.

    Screenshot 2023-11-02 120007

  2. Configure the shortcut to your preferred keybind. Configure for "WikiChrome Shortcut", NOT "Activate Extension".

    Screenshot 2023-11-01 235507

  3. Configure the chrome extension popup to set/unset your active tab as the newly opened tab.

    Screenshot 2023-11-02 115136

  4. You can now search highlighted text by using your keybind on highlighted text. You can also search it within the context menu of a right click. Unreachable results will result in no action.

    Screenshot 2023-11-02 000043

Installation

For just an installation of the extension itself(if you want the file version instead of the Chrome Web Store download),

  1. download/clone the project, and locate the dist folder.
  2. go to Chrome Extensions, and select load unpacked.
  3. select the dist folder as the unpacked folder.
  4. Active Chrome Web Extension

Development

  1. download/clone the project.
  2. run cd WikiChrome
  3. run npm install
  4. run npm run build
  5. go to Chrome Extensions, and select load unpacked.
  6. select the dist folder as the unpacked folder.
  7. Active Chrome Web Extension - Note that any changes made within the project itself will require a reload of the extension for changes to be reflected.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.