Giter VIP home page Giter VIP logo

obsidian-clipper's Introduction

Obsidian Chrome Clipper

Screencast

Screencast

This is an unofficial Chrome Extension to quickly clip a selection on a webpage to Obsidian.

Installing (Chrome)

Since this extension is not yet published, a manual install is required. For this you will need to do the following:

  1. Download/clone this repository
  2. Navigate to the Chrome Extension and enabled developer mode (top right of your window)
  3. Unzip the extension at the build/chrome folder. Or straight from the source with the src folder.
  4. Load unpacked extension and navigate to the folder you just unzipped or src of this repository you just downloaded or cloned.
  5. Chrome will now build the extension and you can use the extension menu to pin in to the user interface.
  6. You're now ready to configure the extension, see the steps below in Usage & Settings:

Installing (Firefox)

  1. Download/clone this repository
  2. Allow unsigned extensions, see https://www.thewindowsclub.com/allow-unsigned-extensions-installed-firefox.
  3. Navigate to the Chrome Addons
  4. Add the zipfile from build/firefox through the cog menu.
  5. You're now ready to configure the extension, see the steps below in Usage & Settings:

This extenion is only tested on Chrome/Firefox on OS X. I've heard people got it working on Unix with the flatpak Obsidian app.

Usage & Settings

  1. Right-click on the extension icon in the menu, and click on options.
  2. A webpage should open where you can configure the options for this extension
  3. You can configure the following:
    • vault: Allows you to specify which vault to open
    • note: The name of the note you want to append to
  4. You can specify the clipping template using placeholders like {clip} and {date}.
  5. Decide if you want a markdown clip (HTML is converted to markdown and added to your clipboard) or plain text.
  6. You cen test if Obsidian opens with the right note with the 'Test Configuration' button. Please know that the chrome-plugin cannot paste the content, you will need to do that yourself!

Once configured, you're now good to go, using it only takes two steps:

  1. Make a selection on a page and click the icon of the extension (or use a shortcut key!).
  2. Obsidian will try to open the specific note within the vault you specified, you can then paste your clipping!

Building further upon this extension

Since Chrome allows you to set a custom shortcut to activate an extenion it should be pretty easy to chain it together with Keyboard Meastro or any other automation technology to both clip & paste the results.

Roadmap

  • Support Firefox
  • Allow a user to create a clipping template
  • Markdown clipping with Turndown
  • Make a option that let's you prepend a Zettelkasten id to the clipping itself? (through the template perhaps?)
  • Date formatting with Moment
  • Once the url-scheme of Obsidian allows the creation of a new note, clip to a new note.
  • In the long term future, maybe even offer the possiblity to search through your notes and append it?
  • If you have any ideas, please create an issue with the feature label on it, thanks! ๐Ÿ˜

Technical explanation

This clipper is made possible with a work-around, since Chrome Extensions are forbidden to open custom url-schemes directly. The way around this issue is a custom html page that is hosted on Github-pages and also included in the repository: docs/clip.html. This little file contains javascript that pulls the data like vault & note out of the url params. With this data, it reconstructs the obsidian url and opens the right note!

Support

Want to support me? You can do so via Ko-Fi:

ko-fi

obsidian-clipper's People

Contributors

jplattel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.