Slurps webpages and saves them as clean, uncluttered Markdown. Think Pocket, but better.
Slurps webpages, cleans off all the crud, and saves them to Obsidian as nice, tidy Markdown files. Think Pocket, but better.
Detailed usage information can be found in the documentation.
Slurp exposes a custom URI which can be used for one-click saves.
Bookmarklets are a simple option for those who prefer them. Simply create a new bookmark with the following URL set:
javascript:(() => document.location.href=`obsidian://slurp?url=${document.URL}`)();
Browser extensions are also coming soon for Firefox and Chrome-compatible browsers. If you want to get started right away, they are currently in beta and can be manually installed. See https://github.com/inhumantsar/slurp-extension for details.
Note properties are used by Obsidian to add metadata to notes. Supported data types include checkboxes (true
and false
values), dates and datetimes, lists, numbers, and good ol' plaintext.
By default, Slurp will try to find relevant metadata and add it to new notes. The plugin settings screen offers a few ways to adjust how this metadata is handled and presented:
For more information, check out the documentation.
If you would like to help test new features before they are officially released:
BRAT: Add a beta plugin for testing
.https://github.com/inhumantsar/slurp
.BRAT will regularly look for updates and install them. This can be configured/disabled in the BRAT settings menu.
Slurp does a couple things differently from the standard Obsidian plugin development setup:
If you are a plugin developer already, using a separate environment for Slurp is recommended.
The Zen of Python is a great styleguide for any language.
When it comes to Typescript specifically, I try to follow the guidelines below. Take these with a grain of salt though. I'm still new to Typescript though and I don't have a ton of professional experience with Javascript generally. If any of these are superdumb, please let me know!
@ts-ignore
unless it's absolutely necessary.I
and type names with T
.map(...)
> for (...) {}
.(k, v) => {...}
and for (let i in somevar)
.Also:
There is a direnv
config which can be used to quickly configure a completely isolated local environment. Setting it up requires a few extra steps though.
sh <(curl -L https://nixos.org/nix/install) --no-daemon
flakes
and nix-command
are enabled, eg: mkdir -p ~/.local/nix && echo "experimental-features = nix-command flakes" >> nix.conf
direnv
, adjusting or removing bin_path
as needed: curl -sfL https://direnv.net/install.sh | bin_path=~/.local/bin bash
direnv
will instruct you to add a line to your .bashrc
, once that's done, run direnv allow
.npm install # not required if using direnv
npm run dev # enable hot-rebuilds of main.js
The usual semantic versioning applies.
manifest-beta.json
provides the dev channel specifications for BRAT.
test-resources/vault
is an Obisidian vault that can be used for testing. As a side-benefit, it's a place to keep development notes.
There is a symlink in the vault's plugins directory which uses a relative path to reference the repository root. This may or may not work for you after cloning. Remove and recreate it if Obsidian doesn't see the plugin properly.
NOTE: The plugin won't work (and may not even be recognized) if you haven't built the project yet!
Hot Reload is a commonly used plugin for Obsidian plugin development. It will watch for modified plugins and automatically reload it within a running Obsidian instance. It's included in the test vault as a submodule, so you will need to update it on first clone:
git submodule update
On Linux:
xdg-open "obsidian://slurp?url=https://..."