README file from
GithubMicrosoft-Compatible Link — Obsidian Plugin
Copy or open a shareable obsid.net link for any note with one click.
obsid.net wraps Obsidian's obsidian:// deep-link scheme in a standard https:// URL so links stay clickable in chat apps, emails, and anywhere that strips custom URI schemes.
Features
- Copy obsid.net link — copies a shareable URL straight to your clipboard
- Open via obsid.net — opens the current note through the obsid.net redirect (useful for testing shared links)
- Command Palette — both actions available via
Ctrl/Cmd + P - Ribbon icon — one-click access from the sidebar (toggleable)
- Settings — choose what the ribbon icon does (copy vs. open)
How it works
Given a vault named MyVault and a note at Projects/Ideas.md, the plugin generates:
https://obsid.net/?vault=MyVault&file=Projects%2FIdeas
Opening that URL in any browser redirects to:
obsidian://open?vault=MyVault&file=Projects%2FIdeas
…which opens the note directly in Obsidian. All conversion happens in the browser; no data is sent to any server.
Installation
From the Obsidian Community Plugins browser (recommended)
- Open Settings → Community plugins → Browse
- Search for obsid.net Link
- Click Install, then Enable
Manual installation
- Download
main.jsandmanifest.jsonfrom the latest release - Create a folder
.obsidian/plugins/obsid-link/inside your vault - Copy the two files into that folder
- Reload Obsidian and enable the plugin under Settings → Community plugins
Usage
| Action | How to trigger |
|---|---|
| Copy obsid.net link | Command Palette → Copy obsid.net link for current note |
| Open via obsid.net | Command Palette → Open current note via obsid.net |
| Ribbon icon | Click the 🔗 icon in the left sidebar |
The ribbon icon action (copy vs. open) is configurable under Settings → obsid.net Link.
Development
# Clone into your vault's plugins folder for live testing
git clone https://github.com/yourusername/obsidian-obsid-link \
/path/to/vault/.obsidian/plugins/obsid-link
cd /path/to/vault/.obsidian/plugins/obsid-link
npm install
npm run dev # watch mode — recompiles on save
Reload Obsidian after each build (or use the Hot Reload community plugin).
Releasing a new version
- Update
minAppVersioninmanifest.jsonif the minimum Obsidian version changed - Run
npm version patch(orminor/major) — this bumpsmanifest.json,package.json, andversions.jsonautomatically - Commit and push, then push the tag:
git push && git push --tags - GitHub Actions builds the plugin and creates a release with the required assets attached
Contributing
Pull requests and issues are welcome. Please open an issue before starting significant work so we can discuss the approach.
Credits
This plugin is a thin Obsidian wrapper around obsid.net, built and maintained by Joost de Valk (founder of Yoast). All the actual link-conversion and redirect logic is his work — the source is at github.com/jdevalk/obsid.net.
This plugin simply brings that service into Obsidian as a native command and ribbon button. If you find obsid.net useful, consider starring his repository.