Skip to content

Ruoyu-Klaus/obsidian-clipper

Repository files navigation

Hi

GitHub release (latest SemVer) License Main pipeline

Welcome to Obsidian Clipper, a browser plugin that makes it easy to clip web content and paste it into your Obsidian vault! With this plugin, you can extract or select content on most of websites(especially article based) and quickly transfer it to your Obsidian vault by clicking the button on the popup. The copied images will be embedded as external references.

Description

Obsidian Clipper is a browser extension used for parsing and clipping web content as a markdown format, and then export to your obsidian vault of provided folder.

Feature

βœ‚οΈ Easy clipping: With just clicking button, you can quickly clip the web content to your Obsidian vault.

πŸ“ Markdown editor panel: Obsidian Clipper provides a markdown editor panel that allows you to edit and format your clipped content before saving it to your vault. With the editor panel, you can edit headings, lists, images, and other formatting to your notes or delete unuseful content. The panel also has a preview mode that lets you see how your content will look once saved by clicking outside of the editing panel.

🎨 Customizable options: Obsidian Clipper allows you to customize your clipping options to suit your needs. You can choose the target Obsidian vault, folder, and content format, making it easy to organize your notes and keep them in the right place.

πŸ›‘οΈ Sanitized content: For your security, Obsidian Clipper sanitizes all content you clip to prevent XSS attacks before it is saved to your local vault.

🌐 Works with many websites: Obsidian Clipper works with many websites, so you can clip content from news articles, blog posts, research papers, and more.

πŸš€ Fast and lightweight: Obsidian Clipper is designed to be fast and lightweight, so it won't slow down your browsing experience. The extension only runs when you use, so you can clip content and continue browsing without any interruptions.

Getting Started:

πŸš€ To start using Obsidian Clipper, simply install the extension in your browser and follow the setup instructions. Once installed, you can setup your preferences and copy or edit the current tab content when opening the extension popup (If nothing shows up, please try to refresh the page)

πŸ™ We hope you find Obsidian Clipper useful in your note-taking and research tasks. If you have any feedback or suggestions, please don't hesitate to leave the comments or send email to me.

Permission

  • Access tabs: used to access the website content when the icon in the browser bar is clicked.
  • Manage Downloads: necessary to be able to download the markdown file.

License

MIT License

Copyright (c) [2023] [Ruoyu Wang]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.