Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharat87/docjump
A fuzzy-finder for methods, fields etc., in documentation reference pages for programming languages and software development frameworks.
https://github.com/sharat87/docjump
chrome-extension documentation-search firefox-extension fuzzy-search
Last synced: 6 days ago
JSON representation
A fuzzy-finder for methods, fields etc., in documentation reference pages for programming languages and software development frameworks.
- Host: GitHub
- URL: https://github.com/sharat87/docjump
- Owner: sharat87
- License: mit
- Created: 2021-02-13T07:48:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-25T06:34:25.000Z (over 3 years ago)
- Last Synced: 2024-10-28T19:41:45.077Z (about 2 months ago)
- Topics: chrome-extension, documentation-search, firefox-extension, fuzzy-search
- Language: JavaScript
- Homepage:
- Size: 1.28 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DocJump
DocJump provides a fuzzy finder (on hitting `Ctrl+Shift+J`) for methods, fields etc. in documentation pages for popular
software development libraries and frameworks including Java and Python. Open source and works completely offline.
The default hotkey to launch DocJump is `Ctrl+Shift+J` (even for macOS), but can be customized in the add-on's options
page. The icon in the URL bar can also be clicked to launch DocJump.
Here's a preview of what this add-on offers:
## Supported Websites
1. Oracle Java JDK (Java)
1. Spring Framework (Java)
1. Project Reactor (Java)
1. Python
1. Docker
1. Jest (Javascript testing framework)
## Get it
[**Get DocJump for Firefox**](https://addons.mozilla.org/en-US/firefox/addon/docjump/).
[**Get DocJump for Chrome**](https://chrome.google.com/webstore/detail/docjump/honoamahndiehddgbkdbdnljdaipbeff).
## Build Instructions
Make sure you have Node.js `v14.15` and yarn `v1.22`.
To build the Firefox extension, run the following commands:
```sh
yarn install --frozen-lockfile
make firefox
```
The Firefox extension should now be located at `dist/firefox-docjump.zip`.
To build the chrome extension, run the following commands:
```sh
yarn install --frozen-lockfile
make chrome
```
The chrome extension should now be located at `dist/chrome-docjump.zip`.
## Support
If you face any problems with the add-on, or want support for a new documentation site, please raise an issue on GitHub.
I'd ask to open an issue even before working on a PR (if you are), so we don't end up duplicating work on the same
thing. Thanks!
I developed this in my spare time (weekends), because I sorely wanted it. Just `Ctrl+F` to find what I want was not
easy. There's *too many* results from `Ctrl+F` that are not what I'm after. This add-on solved it for me.
If you want to show your interest and support for this project, you may want to [buy me a
coffee](https://www.buymeacoffee.com/sharat87). Thank you very much!
## License
This add-on's source code is licensed using the [MIT License](https://github.com/sharat87/docjump/blob/master/LICENSE).