README file from
GithubRich Link Resolver
Rich Link Resolver is an Obsidian plugin that turns a pasted or selected URL into a markdown rich link using the page title and favicon.
Example output:
[ Example Domain](<https://example.com>)
Features
- Automatically resolves a pasted URL when the clipboard contains a single URL.
- Resolves the selected URL or the URL under the cursor through a command or context menu action.
- Shows an inline
Loading URL...placeholder while metadata is being fetched. - Resizes favicons to a stable
16x16local cache so note layout does not break. - Falls back to a plain markdown link if a favicon cannot be downloaded or resized.
Local testing
- Install dependencies:
npm install
- Build the plugin:
npm run build
- Copy it into your vault:
npm run install:local -- "/absolute/path/to/Your Vault"
You can also use:
OBSIDIAN_VAULT_PATH="/absolute/path/to/Your Vault" npm run install:local
- In Obsidian, open
Settings -> Community plugins, reload plugins, and enableRich Link Resolver.
Development
Watch mode:
npm run dev
After each rebuild, copy the latest plugin files again:
npm run install:local -- "/absolute/path/to/Your Vault"
Release process
This repository is set up for GitHub-based releases.
- Update
manifest.json,versions.json, andpackage.jsonto the new version. - Commit and push the changes.
- Create and push a tag in the format
X.Y.Z.
git tag 0.1.0
git push origin 0.1.0
- The GitHub Actions release workflow will build the plugin and attach:
main.jsmanifest.jsonstyles.css
Submit to Obsidian Community Plugins
After the repository has at least one public GitHub release with the files above:
- Go to
https://community.obsidian.mdand sign in with your Obsidian account. - Link your GitHub account to your profile.
- Open
Pluginsin the sidebar and chooseNew plugin. - Submit the repository URL:
https://github.com/almeidazs/rich-link-obsidian. - Follow the review feedback shown by the directory until the submission passes.