README.md

⚠️ Obsidian Web Clipper is still in beta and requires Obsidian 1.7.2. Please make sure you are using Obsidian 1.7.2 or above. Visit the Obsidian Help site for more information.

Getting started

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

• Chrome Web Store for Chrome, Brave, Edge, Arc, Orion, and other Chromium-based browsers.
• Firefox Add-Ons for Firefox and Firefox Mobile.
• Safari Extensions for macOS, iOS, and iPadOS.

Using the extension

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

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

• webextension-polyfill for browser compatibility
• readability for content extraction
• turndown for HTML to Markdown conversion
• dayjs for date parsing and formatting
• lz-string to compress templates to reduce storage space
• lucide for icons
• mathml-to-latex for MathML to LaTeX conversion