edwang09 / hypothesis_extension

Hypothesis browser extension(s)

The Hypothesis browser extensions allow you to annotate web documents using your Hypothesis account.

Choose your browser below

Chrome	Firefox
Now available	In development

Development

The code for the extensions is in the src/ directory, and can be built into a browser extension by running:

yarn install
make

Once this is done you should be able to load the build/ directory as an unpacked extension.

The extension code has a test suite, which you can run using:

yarn test

Note that the browser extensions are for the most part just a wrapper around the Hypothesis client. Depending on what you're interested in working on, you may need to check out the client repository too. If you do that, you can get the browser extension repository to use your checked-out client repository by running

yarn link

in the client repository, and then

yarn link hypothesis

in the browser-extension repository. After that, a call to make will use the built client from the client repository. Please consult the client's documentation for instructions on building the client in a development environment.

Tip: To unlink your dev browser extension from your dev client run yarn unlink hypothesis in your browser extension directory (see the yarn uninstall docs).

See Building the extension for more information.

Note for Safari

To build and test in Safari, make sure you have safari 14 and xcode 12 or above, and run the following instead:

yarn install
make SETTINGS_FILE=settings/safari-dev.json
xcrun safari-web-extension-converter ./build --swift --force --project-location ./safari-build

Once xcode is open, click the play button to test the extension.

Community

Join us on Slack for discussion. Please see our contact page for details of how to register.

For help using the extension, please see our Help pages.

If you'd like to contribute to the project, you should consider subscribing to the development mailing list, where we can help you plan your contributions.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

The Hypothesis browser extensions are released under the 2-Clause BSD License, sometimes referred to as the "Simplified BSD License". Some third-party components are included. They are subject to their own licenses. All of the license information can be found in the included LICENSE file.