Skip to content

sharat87/docjump

Repository files navigation

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:

GIF Preview

Supported Websites

  1. Oracle Java JDK (Java)
  2. Spring Framework (Java)
  3. Project Reactor (Java)
  4. Python
  5. Docker
  6. Jest (Javascript testing framework)

Get it

Get DocJump for Firefox.

Get DocJump for Chrome.

Build Instructions

Make sure you have Node.js v14.15 and yarn v1.22.

To build the Firefox extension, run the following commands:

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:

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. Thank you very much!

License

This add-on's source code is licensed using the MIT License.

About

A fuzzy-finder for methods, fields etc., in documentation reference pages for programming languages and software development frameworks.

Topics

Resources

License

Stars

Watchers

Forks

Contributors