jce-clipper
v0.1.1
Published
Web Clipper For Obsidian By Jnjsoft
Downloads
8
Readme
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:
- Chrome Web Store for Chrome, Brave, Arc, Orion, and other Chromium-based browsers.
- Firefox Add-Ons for Firefox and Firefox Mobile.
- Safari Extensions for macOS, iOS, and iPadOS.
- Edge Add-Ons for Microsoft Edge.
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
- [ ] Template directory
- [ ] Template validation
- [ ] Template logic (if/for)
- [x] Save images locally, added in Obsidian 1.8.0
Developers
To build the extension:
npm run build
This will create three directories:
dist/
for the Chromium versiondist_firefox/
for the Firefox versiondist_safari/
for the Safari version
Install the extension locally
For Chromium browsers, such as Chrome, Brave, Edge, and Arc:
- Open your browser and navigate to
chrome://extensions
- Enable Developer mode
- Click Load unpacked and select the
dist
directory
For Firefox:
- Open Firefox and navigate to
about:debugging#/runtime/this-firefox
- Click Load Temporary Add-on
- Navigate to the
dist_firefox
directory and select themanifest.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
- dompurify for sanitizing HTML