Skip to content

Highlight and capture the web in your favorite browser. The official Web Clipper extension for Obsidian.

License

Notifications You must be signed in to change notification settings

obsidianmd/obsidian-clipper

Repository files navigation

Obsidian Web Clipper helps you highlight and capture the web in your favorite browser. Anything you save is stored as durable Markdown files that you can read offline, and preserve for the long term.

Get started

Install the extension by downloading it from the official directory for your browser:

Use the extension

Documentation is available on the Obsidian Help site, which covers how to use highlighting, templates, variables, filters, and more.

Contribute

Translations

You can help translate Web Clipper into your language. Submit your translation via pull request using the format found in the /locales folder.

Features and bug fixes

See the help wanted tag for issues where contributions are welcome.

Roadmap

In no particular order:

  • A separate icon for Web Clipper
  • Translate UI into more languages — help is welcomed
  • Annotate highlights
  • Save images locally — requires changes to Obsidian app
  • Template directory
  • Template validation
  • Template logic (if/for)
  • Save Markdown with inline highlights
  • RTL support

Developers

To build the extension:

npm run build

This will create three directories:

  • dist/ for the Chromium version
  • dist_firefox/ for the Firefox version
  • dist_safari/ for the Safari version

Install the extension locally

For Chromium browsers, such as Chrome, Brave, Edge, and Arc:

  1. Open your browser and navigate to chrome://extensions
  2. Enable Developer mode
  3. Click Load unpacked and select the dist directory

For Firefox:

  1. Open Firefox and navigate to about:debugging#/runtime/this-firefox
  2. Click Load Temporary Add-on
  3. Navigate to the dist_firefox directory and select the manifest.json file

Third-party libraries